Skip to content

Commit a974445

Browse files
committed
Add prerequisite page
1 parent 6e2b70c commit a974445

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Part 1: Building, debugging, and contributing to Rustc](./part-1-intro.md)
88
- [About the compiler team](./compiler-team.md)
99
- [How to Build and Run the Compiler](./building/how-to-build-and-run.md)
10+
- [Prerequisites](./building/prerequisites.md)
1011
- [Suggested Workflows](./building/suggested.md)
1112
- [Bootstrapping](./building/bootstrapping.md)
1213
- [Distribution artifacts](./building/build-install-distribution-artifacts.md)

src/building/prerequisites.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Prerequisites
2+
3+
Before building the compiler, you need the following things installed:
4+
5+
* Python
6+
* A C/C++ compiler toolchain
7+
* cmake
8+
* rustc
9+
10+
## `rustc` and toolchain installation
11+
12+
Follow the installation given in the [Rust book](https://doc.rust-lang.org/book/ch01-01-installation.html) to install a working `rustc` and the necessary C/++ toolchain on your platform.
13+
14+
## Platform specific instructions
15+
16+
### Windows
17+
18+
* Install [winget](https://github.com/microsoft/winget-cli)
19+
20+
Run the following in a terminal:
21+
22+
```
23+
winget install python
24+
winget install cmake
25+
```
26+
27+
If any of those is installed already, winget will detect it.
28+
29+
Edit your systems `PATH` variable and add: `C:\Program Files\CMake\bin`.

0 commit comments

Comments
 (0)