From f7aea62c45f870fd5ff3d14d88d5fab16b490c91 Mon Sep 17 00:00:00 2001 From: Jonni Liljamo Date: Mon, 11 Nov 2024 13:33:17 +0200 Subject: [PATCH] docs: add development notes to README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6337e6a..c1c10d3 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,19 @@ tldr: gRPC was easier lmao. - Master should notify if a Worker becomes unreachable... - ...without sending the message described above, "graceful shutdown". +## Development + +- There's a [flake.nix](./flake.nix) which defines a development shell with + the Rust toolchain and all the required dependencies ready to go. + - Also configures pre-commit hooks. +- There's a [justfile](./justfile) which defines common commands. Requires + [just](https://github.com/casey/just). +- `x86_64-unknown-linux-gnu` builds use [mold](https://github.com/rui314/mold) as + the default linked, defined in [.cargo/config.toml](./.cargo/config.toml). +- When using the `trace` feature, you need `--cfg tokio_unstable`, which is also + set in [.cargo/config.toml](./.cargo/config.toml) for `x86_64-unknown-linux-gnu builds`. + - Otherwise, you can set `RUSTFLAGS="--cfg tokio_unstable"`. + ## License This project is licensed under [GNU General Public License v3.0 or later](./LICENSE). -- 2.44.1