Development Environment Setup
Using VS Code
Clone the repo↗ and open the folder in VS Code↗. Edit .devcontainer/.env if needed. VS Code should prompt you to open the code in a docker↗ container, which installs mdbook↗ and rust tooling automatically. Make sure you have previously installed
- Dev Container extension↗.
- Docker Desktop↗ (or at least the Docker engine).
Note that opening the code folder in VS Code may take a little while the first time around.
Other
If you are not using VS Code, install the Dev Container CLI↗ or simply install the required tools on your local machine:
sudo apt-get update # Or equivalent for other distros
# sudo apt-get install fzf # Optional
# sudo apt-get mold clang # If using
rustup update
rustup component add clippy
cargo install cargo-nextest
cargo install mdbook
cargo install just
cargo install mdbook-linkcheck
cargo install mdbook-utils
# for `cargo +nightly fmt`
rustup toolchain install nightly
rustup component add rustfmt --toolchain nightly
You may need sudo apt-get install libsqlite3-dev on WSL.
Review .devcontainer/Dockerfile↗ for other dependencies.
Alternative just Install
just↗
sudo apt update
apt-get -y install just
Alternative mdbook Install
# RUN <<EOF
# set -e
# wget -c <https://github.com/rust-lang/mdBook/releases/download/v0.4.36/mdbook-v0.4.36-x86_64-unknown-linux-gnu.tar.gz> -O - | sudo tar -xvz -C /usr/local/bin
# EOF