Skip to content

Commit

Permalink
Add prerequisite page
Browse files Browse the repository at this point in the history
  • Loading branch information
skade authored and mark-i-m committed Jun 18, 2020
1 parent 6c580ad commit 38cd933
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Getting Started](./getting-started.md)
- [About the compiler team](./compiler-team.md)
- [How to Build and Run the Compiler](./building/how-to-build-and-run.md)
- [Prerequisites](./building/prerequisites.md)
- [Suggested Workflows](./building/suggested.md)
- [Bootstrapping](./building/bootstrapping.md)
- [Distribution artifacts](./building/build-install-distribution-artifacts.md)
Expand Down
29 changes: 29 additions & 0 deletions src/building/prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Prerequisites

Before building the compiler, you need the following things installed:

* Python
* A C/C++ compiler toolchain
* cmake
* rustc

## `rustc` and toolchain installation

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.

## Platform specific instructions

### 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`.

0 comments on commit 38cd933

Please sign in to comment.