Skip to content

Commit 6e84621

Browse files
mkroeningjounathaen
authored andcommitted
rust-toolchain.toml: Pin toolchain channel
1 parent a1c557b commit 6e84621

File tree

3 files changed

+11
-32
lines changed

3 files changed

+11
-32
lines changed

README.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -45,48 +45,21 @@ $ apt-get install -y git curl wget nasm make autotools-dev gcc g++ build-essenti
4545
```
4646

4747
### Common for macOS, Windows and Linux
48-
It is required to install the Rust toolchain.
49-
Please visit the [Rust website](https://www.rust-lang.org/) and follow the installation instructions for your operating system.
50-
It is important that the *nightly channel* is used to install the toolchain.
51-
This is queried during installation and should be answered as appropriate.
52-
53-
Afterwards the installation the source code of Rust runtime and the llvm tools are required to build the kernel:
54-
55-
```sh
56-
$ rustup component add rust-src
57-
$ rustup component add llvm-tools-preview
58-
```
48+
This project uses Rustup to set its Rust toolchain.
49+
Follow the instructions to [install Rust using Rustup](https://www.rust-lang.org/tools/install).
5950

6051
eduOS-rs is able to run within [ehyve](https://github.com/RWTH-OS/ehyve), which a specialized hypervisor for eduOS-rs.
6152
Therefore [ehyve](https://github.com/RWTH-OS/ehyve) must be installed.
6253

6354
```sh
64-
$ cargo install --git https://github.com/RWTH-OS/ehyve.git
55+
$ cargo +nightly install --git https://github.com/RWTH-OS/ehyve.git --locked
6556
```
6657

6758
Please check if your system fullfil ehyve's [system requirements](https://github.com/RWTH-OS/ehyve).
6859

69-
To build the kernel, it is important to add the path to *llvm-tools* to the environment variable `PATH`.
70-
Depening on the operating systems, the tools are located at:
71-
72-
* Linux: `~/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-unknown-linux-gnu/bin`
73-
* MacOS: `~/.rustup/toolchains/nightly-x86_64-apple-darwin/lib/rustlib/x86_64-apple-darwin/bin`
74-
* Windows: `%USERPROFILE%\.rustup\toolchains\nightly-x86_64-pc-windows-msvc\lib\rustlib\x86_64-pc-windows-msvc\bin`
75-
7660
## Building
7761

78-
The final step is to create a copy of the repository and to build the kernel:
79-
80-
```sh
81-
$ # Get our source code.
82-
$ git clone https://github.com/RWTH-OS/eduOS-rs.git
83-
$ cd eduOS-rs
84-
85-
$ # Build kernel
86-
$ cargo build
87-
```
88-
89-
From here, we should be able to run the kernel in ehyve:
62+
After cloning the repository, you can run the kernel with ehyve:
9063

9164
```sh
9265
$ cargo run

rust-toolchain

Lines changed: 0 additions & 1 deletion
This file was deleted.

rust-toolchain.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[toolchain]
2+
channel = "nightly-2021-02-11"
3+
components = [
4+
"clippy",
5+
"rustfmt",
6+
"rust-src",
7+
]

0 commit comments

Comments
 (0)