Commit beccbc68 authored by Jeremy Soller's avatar Jeremy Soller Committed by GitHub

Merge pull request #121 from MggMuggins/master

Clear up the documentation for setting up and compiling
parents 26679a19 7501a497
......@@ -21,8 +21,8 @@
- [Getting started](./getting_started/getting_started.md)
- [Trying Redox in a virtual machine](./getting_started/try_vm.md)
- [Running Redox on real hardware](./getting_started/real_hardware.md)
- [Preparing the build](./getting_started/preparing_the_build.md)
- [Installing the toolchain](./getting_started/installing_the_toolchain.md)
- [Preparing the build](./getting_started/preparing_the_build.md)
- [Compiling Redox](./getting_started/compiling_redox.md)
- [Exploring Redox](./getting_started/exploring_redox.md)
- [Questions and feedback](./getting_started/asking_questions_giving_feedback.md)
......
Installing the toolchain
========================
The redox toolchain is required in order to compile certain parts of redox. This basically entails installing a patched version of gcc.
### Ubuntu and other Debian based systems
To install the toolchain, run the following commands:
......@@ -20,11 +22,11 @@ sudo apt install x86-64-unknown-redox-gcc
### Arch Linux
To install the toolchain, run the following commands:
```bash
```bash
# Clone libc
git clone --recursive git@github.com:redox-os/libc
# Go to the packages
# Go to the packages
cd libc/packages/arch
# Start with binutils
......@@ -50,7 +52,7 @@ To install the toolchain, run the following commands:
### Other distros/Mac OS X
To install the toolchain, run the following commands:
```bash
```bash
# Clone libc
git clone --recursive git@github.com:redox-os/libc
......
......@@ -55,7 +55,7 @@ $ brew install redox-os/gcc_cross_compilers/x86_64-elf-gcc
Setting Up Nightly Rust
-----------------------
While the following step is not _required_, it is recommended. If you already have a functioning Rust nightly installation, you can skip this step:
The following step is not required _if_ you already have a functioning Rust nightly installation. Nightly is required.
We will use `rustup` to manage our Rust versions:
......@@ -63,12 +63,7 @@ We will use `rustup` to manage our Rust versions:
$ curl https://sh.rustup.rs -sSf | sh
```
Rustup will install the `stable` version of Rust. To run Redox, you have to install the `nightly` version of Rust, like this:
```sh
$ rustup toolchain install nightly
$ rustup override set nightly
```
You may need to run rustup to install the recommended nightly version.
There is one more tool we need from Rust to install Redox. It is called Xargo. Xargo allows us to have a custom `libstd`
```sh
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment