Getting Started
Dependencies
You should install the following:
cargo
: https://doc.rust-lang.org/cargo/getting-started/installation.htmlmake
: https://www.gnu.org/software/make/
Commands
From the root directory, you may use the following commands:
- Build using
make build
- Test using
make test
- Run CI equivalent using
make ci
Project Structure
The project structure for permakeep was based on Astral's uv
and ruff
.
It uses a flat crate structure.