lazyoxen / redox

Redox: A Rust Operating System

Redox is a Rust based operating system, designed to be modular and secure. The developer blog can be found at http://www.redox-os.org

Docs can be found here.

Please make sure you use the latest nightly before the building.

What it looks like

Help! Redox won't compile!

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

1. Run make clean.
2. Run git clean -X -f -d
3. Make sure you got the latest version of Rust nightly! (you can use multirust for managing Rust versions).
4. Update LLVM, GNU Make, nasm and QEMU/VirtualBox.
5. Pull the upstream master branch (git remote add upstream [email protected]:redox-os/redox.git; git pull upstream master).

and then rebuild!

Building on Debian/Ubuntu

• Run the setup script and enter your password when prompted (to install Rust compiler and its dependencies)

cd setup
./ubuntu.sh
./binary.sh

• Make the project

make all

Running on Debian/Ubuntu

• Install VirtualBox

sudo apt-get install virtualbox

• Run VirtualBox

make virtualbox

Running on Debian/Ubuntu (Qemu, Advanced)

• Install Qemu

sudo apt-get install qemu-system-x86 qemu-kvm

• Run Qemu

make qemu

Building on Arch Linux

• Run the setup script and enter your password when prompted (to install the Rust compiler and its dependencies)

cd setup
./arch.sh
./binary.sh

• Make the project

make

Running on Arch Linux

• Virtualbox was completely setup as part of the script.
• Run Virtualbox

make virtualbox

Running on Arch Linux (Qemu)

• Install Qemu

$ sudo pacman -S qemu

• Run redox

$ make qemu

Building on Fedora

• Run the setup script and enter your password when prompted (to install Rust compiler and its dependencies)

cd setup
./fedora.sh
./binary.sh

• Make the project

make all

Running on Fedora (Qemu, Advanced)

• Install Qemu

sudo yum install qemu-system-x86 qemu-kvm

• Run Qemu

make qemu

Building on OS X

• Install MacPorts or Homebrew
• Run the setup script and enter your password when prompted (to install Rust compiler and its dependencies)

cd setup
# MacPorts
./osx-macports.sh
# Homebrew
./osx-homebrew.sh
./binary.sh

• Make the project

make all

Running on OS X

• Install VirtualBox from https://www.virtualbox.org/wiki/Downloads
• Make sure it is installed for all users, in /Applications/ or edit the Makefile VBM path
• Run VirtualBox

make virtualbox

Building on Windows

• Download and install the latest 32-bit Rust nightly from http://www.rust-lang.org/install.html
• The direct link to the 32-bit nightly is https://static.rust-lang.org/dist/rust-nightly-i686-pc-windows-gnu.msi
• Open the Rust nightly shell in the redox repository

make all

Running on Windows

• Install VirtualBox from https://www.virtualbox.org/wiki/Downloads
• Make sure to install to C:\Program Files\Oracle\VirtualBox or edit the Makefile VBM path
• Run VirtualBox

make virtualbox