Whether you want to contribute to the codebase or just to the documentation, there are a few things you should have before getting started:
- git, GitHub Desktop, GitKraken or any other Git client
- rustup
- some editor: Visual Studio Code
This project is almost exclusively written in Rust so here are some editors and plugins you should use to make your life easier:
- Free: Visual Studio Code + rust-analyzer extension
- Paid (or free for students and if you have an open-source license): CLion + Rust extension
If you have CLion, you can use the pre-configured Run Configurations in .run/.
To get started, you first need the nightly toolchain to compile the code:
rustup toolchain install nightlyYou should also install and use clippy and rustfmt:
rustup component add clippy rustfmtIf you add or change any dependencies you should run cargo-deny and make sure there are no issues:
cargo install cargo-deny
cargo deny check- clippy:
cargo clippy - rustfmt:
cargo fmt - benchmark:
cargo bench - cargo-deny:
cargo deny check