-
Notifications
You must be signed in to change notification settings - Fork 547
Add prerequisite page #723
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,56 @@ | ||
# Prerequisites | ||
|
||
** Coming Soon: https://github.com/rust-lang/rustc-dev-guide/pull/723 ** | ||
## Dependencies | ||
|
||
Before building the compiler, you need the following things installed: | ||
|
||
* `g++` 5.1 or later or `clang++` 3.5 or later | ||
* `python` 3 or 2.7 | ||
* GNU `make` 3.81 or later | ||
* `cmake` 3.4.3 or later | ||
* `curl` | ||
* `git` | ||
* `ssl` which comes in `libssl-dev` or `openssl-devel` | ||
* `pkg-config` if you are compiling on Linux and targeting Linux | ||
|
||
Additionally, if you want to build `rustc` with your system's LLVM, you will | ||
need `llvm-config`. See [this section for more info][sysllvm]. | ||
|
||
[sysllvm]: ./suggested.md#building-with-system-llvm | ||
|
||
## Hardware | ||
|
||
These are not so much requirements as _recommendations_: | ||
|
||
* ~15GB of free disk space (~25GB or more if doing incremental builds). | ||
* >= 8GB RAM | ||
* >= 4 cores | ||
* Internet access | ||
|
||
Beefier machines will lead to much faster builds. If your machine is not very | ||
powerful, a common strategy is to only use `./x.py check` on your local machine | ||
and let the CI build test your changes when you push to a PR branch. | ||
|
||
## `rustc` and toolchain installation | ||
|
||
Follow the installation given in the [Rust book][install] to install a working | ||
`rustc` and the necessary C/++ toolchain on your platform. | ||
|
||
[install]: https://doc.rust-lang.org/book/ch01-01-installation.html | ||
|
||
## Platform specific instructions | ||
mark-i-m marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Windows | ||
|
||
* Install [winget](https://github.com/microsoft/winget-cli) | ||
|
||
Run the following in a terminal: | ||
|
||
``` | ||
winget install python | ||
winget install cmake | ||
``` | ||
|
||
If any of those is installed already, winget will detect it. | ||
|
||
Edit your systems `PATH` variable and add: `C:\Program Files\CMake\bin`. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.