1 files changed, 13 insertions(+), 0 deletions(-)

M 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).