redox-os/redox

Redox is an operating system written in pure Rust, designed to be modular and secure. The development blog can be found at http://www.redox-os.org.

Documentation can be found here.

Please make sure you use the latest nightly of rustc before building (for more troubleshooting, see "Help! Redox won't compile!").

What it looks like

Help! Redox won't compile!

Sometimes things go wrong when compiling. Try the following before opening an issue:

Run make clean.

Run git clean -X -f -d.

Make sure you have the latest version of Rust nightly! (multirust is recommended for managing Rust versions).
Update GNU Make, NASM and QEMU/VirtualBox.
Pull the upstream master branch (git remote add upstream git@github.com:redox-os/redox.git; git pull upstream master).

and then rebuild!

Contributing to Redox

If you're interested in this project, and you'd like to help us out, here is a list of ways you can do just that.

Cloning, Building, and Running

Quick Setup

$ cd path/to/your/projects/folder/

# Run bootstrap setup
$ curl -sf https://raw.githubusercontent.com/redox-os/redox/master/bootstrap.sh -o bootstrap.sh && bash -e bootstrap.sh

# Build Redox
$ make all

# Launch using VirtualBox
$ make virtualbox

# Launch using QEMU
$ make qemu
# Launch using QEMU without using KVM (Kernel Virtual Machine). Try if QEMU gives an error.
$ make qemu_no_kvm

Manual Setup

To manually clone, build and run Redox using a Linux host, run the following commands (with exceptions, be sure to read the comments):

$ cd path/to/your/projects/folder/

# HTTPS
$ git clone https://github.com/redox-os/redox.git --origin upstream --recursive
# SSH
$ git clone git@github.com:redox-os/redox.git --origin upstream --recursive

$ cd redox/

# Install/update dependencies
$ sudo <your package manager> install llvm make nasm virtualbox virtualbox-dkms qemu qemu-kvm

# Install multirust
$ curl -sf https://raw.githubusercontent.com/brson/multirust/master/blastoff.sh | sh

# Set override toolchain to nightly build
$ multirust override nightly

# Build Redox
$ make all

# Launch using VirtualBox
$ make virtualbox

# Launch using QEMU
$ make qemu
# Launch using QEMU without using KVM (Kernel Virtual Machine). Try if QEMU gives an error.
$ make qemu_no_kvm

Failed to load latest commit information.
crates	Fixes for new ion	Dec 22, 2015
filesystem	Cleanup missing spaces in terminal	Dec 28, 2015
img	Ho ho ho!	Dec 24, 2015
kernel	Merge pull request #402 from Ticki/master	Dec 28, 2015
liballoc_system	feature(no_std) no longer required	Dec 15, 2015
libc	Add error codes	Dec 9, 2015
liborbital	Use less pointer sized integer, fix type mismatch	Dec 21, 2015
liborbtk @ a43b524	Use less pointer sized integer, fix type mismatch	Dec 21, 2015
libredox	Fixes for new ion	Dec 23, 2015
rust @ 660787e	Update rust; Don't use raw pointers for BSS start/end	Dec 28, 2015
setup	Merge pull request #353 from MaximilianMeister/debug/binary_sh	Dec 7, 2015
tests	Updating to origin/master	Oct 2, 2015
windows	Add basename	Sep 26, 2015
.gitignore	Update gitignore	Nov 13, 2015
.gitmodules	Switch to using the ion repo	Dec 14, 2015
.travis.yml	Run travis tests on containers	Oct 23, 2015
CONTRIBUTING.md	attempt to fix merge conflicts	Dec 22, 2015
LICENSE.md	Sorry Charlie, all the original Rustboot code has been gone for sever…	Dec 14, 2015
Makefile	More AHCI stuff	Dec 28, 2015
README.md	Merge pull request #398 from Ticki/master	Dec 24, 2015
appveyor.yml	set correct path for appveyor	Oct 5, 2015
bochs.i386	Revert bochs	Dec 2, 2015
bochs.x86_64	Revert bochs	Dec 3, 2015
bootstrap.sh	qemu_no_kvm suggested for all OSs	Dec 21, 2015
i386-unknown-redox.json	WIP: Emit true rust executables	Dec 9, 2015
make.bat	Added a batchfile for easier windows builds	Oct 20, 2015
x86_64-unknown-redox.json	Get a little closer to compiling executables	Dec 9, 2015