To build this project you'll need rust and cargo.
This package is called owmods_core
so anytime you want to perform cargo commands on it do not do it in this folder, do it from the root of the repo and add -p owmods_core
to your cargo command.
Ex: cargo add tokio
should become cargo add clap -p owmods_core
.
Upon editing any structs marked with #[typeshare]
, you'll need to regenerate TypeScript bindings for the GUI. See the typeshare section of the GUI contributing file for more info.
To run tests run cargo test -p owmods_core
Please format and lint your code before pushing:
cargo fmt
cargo lint
Git hooks are setup to run clippy on every commit, meaning they may take longer.