book/src/development/environment.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

2023-04-17 21:23:10 +00:00
# Configuring a Build Environment
```admonish info
All of this build information is for `Linux` right now, as I don't want to mess around with getting stuff working on `Windows`.
Just use `WSL` if you want.
`BSD` should work similarly, but if not, please let us know!
```
Of course, first you will need to install `Rust`. The best way to do this is through [rustup](https://www.rust-lang.org/tools/install).
Additionally, you will need to install [clippy](https://doc.rust-lang.org/nightly/clippy/installation.html) and [rustfmt](https://github.com/rust-lang/rustfmt).
2023-04-17 22:42:17 +00:00
You probably will also want to `cargo install sccache`, and export the `RUSTC_WRAPPER='sccache'` environment variable however your shell does it.
2023-04-17 21:23:10 +00:00
Then, you'll want to `git clone` whatever repository you're wanting to work on.
## Building
**TODO:** Figure out how building actually works.
When you're just testing, `cargo` will use the `dev` profile.
This will allow for debugging, and faster compilation speeds.
However, all releases will be using the `release` profile, which is much slower, but better optimized.
It's unlikely you'll want to use this on your computer.