|
1 | | -# Installation for Mac OS (Intel / M1 / M2) |
| 1 | +# Installation |
2 | 2 |
|
3 | | -## Basics |
| 3 | +Make sure to have enough free disk space for Rust compilation. |
| 4 | + |
| 5 | +Windows users should use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and follow instructions for Linux. |
| 6 | + |
| 7 | +## Installation for Mac OS (Intel / M1 / M2) |
| 8 | + |
| 9 | +### Basics |
4 | 10 |
|
5 | 11 | * Xcode command line tools |
6 | 12 | - `xcode-select --install` |
|
15 | 21 | * Protoc |
16 | 22 | - `brew install protobuf` |
17 | 23 |
|
18 | | -## Services |
19 | | - |
20 | | -* https://aws.amazon.com/cli/ |
21 | | -* https://docs.docker.com/desktop/mac/install/ |
22 | | - |
23 | | -## Additional tooling required by tests |
| 24 | +### Additional tooling required by tests |
24 | 25 |
|
25 | 26 | * `brew install jq` |
26 | 27 | * `cargo install cargo-rdme` |
27 | 28 | * `cargo install taplo-cli` |
28 | 29 | * `cargo install cargo-all-features` |
29 | 30 | * `cargo install cargo-machete` |
| 31 | +* https://docs.docker.com/desktop/mac/install/ |
30 | 32 |
|
31 | | -# Installation for Linux |
| 33 | +## Installation for Linux |
32 | 34 |
|
33 | | -## Basics |
| 35 | +### Basics |
34 | 36 |
|
| 37 | +* [Git](https://git-scm.com/downloads) |
35 | 38 | * Rust |
36 | 39 | - `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` |
37 | 40 | - `rustup target add wasm32-unknown-unknown` |
|
42 | 45 |
|
43 | 46 | Alternatively, we have added experimental Nix support (see `flake.nix`). |
44 | 47 |
|
45 | | -## Services |
46 | | - |
47 | | -* https://aws.amazon.com/cli/ |
48 | | -* https://docs.docker.com/engine/install/ |
49 | | - |
50 | | -## Additional tooling |
| 48 | +### Additional tooling required by tests |
51 | 49 |
|
52 | 50 | * `sudo apt-get install jq` |
53 | 51 | * `cargo install cargo-rdme` |
54 | 52 | * `cargo install taplo-cli` |
55 | 53 | * `cargo install cargo-all-features` |
56 | 54 | * `cargo install cargo-machete` |
| 55 | +* https://docs.docker.com/engine/install/ |
57 | 56 |
|
58 | | -# Installation using Nix |
| 57 | +## Installation using Nix |
59 | 58 |
|
60 | 59 | Alternatively, this repository contains a Nix flake that can be used |
61 | 60 | to prepare a reproducible development environment on Nix-enabled |
|
0 commit comments