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.

# RUN <<EOF
# set -e
# wget -qO - '<https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub>' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
# echo "deb [arch=all,$(dpkg --print-architecture) signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
# sudo apt update
# apt-get -y install just
# EOF

# 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