Skip to content

Commit 783c1fa

Browse files
mkroeningjounathaen
authored andcommitted
rust-toolchain.toml: Pin toolchain channel
1 parent 64b414b commit 783c1fa

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
@@ -51,48 +51,21 @@ $ apt-get install -y git curl wget nasm make autotools-dev gcc g++ build-essenti
5151
```
5252

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

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

6960
```sh
70-
$ cargo install --git https://github.com/RWTH-OS/ehyve.git
61+
$ cargo +nightly install --git https://github.com/RWTH-OS/ehyve.git --locked
7162
```
7263

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

75-
To build the kernel, it is important to add the path to *llvm-tools* to the environment variable `PATH`.
76-
Depening on the operating systems, the tools are located at:
77-
78-
* Linux: `~/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-unknown-linux-gnu/bin`
79-
* MacOS: `~/.rustup/toolchains/nightly-x86_64-apple-darwin/lib/rustlib/x86_64-apple-darwin/bin`
80-
* Windows: `%USERPROFILE%\.rustup\toolchains\nightly-x86_64-pc-windows-msvc\lib\rustlib\x86_64-pc-windows-msvc\bin`
81-
8266
## Building
8367

84-
The final step is to create a copy of the repository and to build the kernel:
85-
86-
```sh
87-
$ # Get our source code.
88-
$ git clone https://github.com/RWTH-OS/eduOS-rs.git
89-
$ cd eduOS-rs
90-
91-
$ # Build kernel
92-
$ cargo build
93-
```
94-
95-
From here, we should be able to run the kernel in ehyve:
68+
After cloning the repository, you can run the kernel with ehyve:
9669

9770
```sh
9871
$ 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)