Skip to content

Commit 071c59f

Browse files
committed
address review comments
1 parent e936b85 commit 071c59f

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

src/building/prerequisites.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,42 @@
11
# Prerequisites
22

3+
## Dependencies
4+
35
Before building the compiler, you need the following things installed:
46

5-
* Python
6-
* A C/C++ compiler toolchain
7-
* cmake
8-
* rustc
7+
* `g++` 5.1 or later or `clang++` 3.5 or later
8+
* `python` 3 or 2.7
9+
* GNU `make` 3.81 or later
10+
* `cmake` 3.4.3 or later
11+
* `curl`
12+
* `git`
13+
* `ssl` which comes in `libssl-dev` or `openssl-devel`
14+
* `pkg-config` if you are compiling on Linux and targeting Linux
15+
16+
Additionally, if you want to build `rustc` with your system's LLVM, you will
17+
need `llvm-config`. See [this section for more info][sysllvm].
18+
19+
[sysllvm]: ./suggested.md#building-with-system-llvm
20+
21+
## Hardware
22+
23+
These are not so much requirements as _recommendations_:
24+
25+
* ~15GB of free disk space (~25GB or more if doing incremental builds).
26+
* >= 8GB RAM
27+
* >= 4 cores
28+
* Internet access
29+
30+
Beefier machines will lead to much faster builds. If your machine is not very
31+
powerful, a common strategy is to only use `./x.py check` on your local machine
32+
and let the CI build test your changes when you push to a PR branch.
933

1034
## `rustc` and toolchain installation
1135

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.
36+
Follow the installation given in the [Rust book][install] to install a working
37+
`rustc` and the necessary C/++ toolchain on your platform.
38+
39+
[install]: https://doc.rust-lang.org/book/ch01-01-installation.html
1340

1441
## Platform specific instructions
1542

0 commit comments

Comments
 (0)