Development Notes

All common commands should be found in the justfile.

You can run these with just.

Simple local dev loop

When running with debug_assertions enabled rgr will write its log file to rgr.log in the current working directory.

Thus, it's fairly straightforward to use a development flow with two terminals:

# Terminal 1
# This follows and displays `rgr`'s logs
just dev-logs

# Terminal 2
# This builds and runs `rgr` in debug mode with logging enabled
just dev <rg args>

The README in this repository is generated from the doc comments in src/main.rs.

Once the doc comments have been updated, run just readme to apply the changes to the README.

Some guidelines:

All development is done on the next branch, so please target that for any Pull Request.
- (Exceptions can be made for PRs that only update the README or don't change any code)
Make sure to run just fmt on each commit so formatting is consistent
Make sure to also use just test to ensure each commit passes the tests

Mostly so I don't forget if I come back to this project after a while.