mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

hacking: Update docs with 'just' commands

This commit is contained in:
Adrian Duke 2026-04-08 19:05:02 +01:00 committed by Fintan Halpenny
parent 6e2b710358
commit b0af317eaa
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
HACKING.md
View File

@ -29,6 +29,16 @@ The repository is structured in *crates*, as follows:
* `radicle-term`: A generic terminal library used by the Radicle CLI. * `radicle-term`: A generic terminal library used by the Radicle CLI.
* `radicle-tools`: Tools used to aid in the development of Radicle. * `radicle-tools`: Tools used to aid in the development of Radicle.
## Task runner
We use [`just`](https://just.systems/) to manage project tasks such as linting, formatting, and installing git hooks. To see a list of all available commands, run:
$ just
If you are not using Nix, it is highly recommended to install the git hooks to automatically run checks before committing and pushing:
$ just install-hooks
## Running in debug mode ## Running in debug mode
To run the services or the CLI in debug mode, use `cargo run -p <package>`. To run the services or the CLI in debug mode, use `cargo run -p <package>`.