diff --git a/README.md b/README.md index eff6db1dc8fdb4bbe5fbb7b0c2771dded8f700e9..48d91045860cde2f927b12bb81b56d4f361506b9 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,19 @@ [](https://gitlab.isae-supaero.fr/dragoon/komodo/-/pipelines) [](https://github.com/dragoon-rs/komodo/actions) +Komodo uses a build system entirely writen in Rust. +- [`cargo-script`](https://crates.io/crates/cargo-script) to build the script +- [`nob.rs`](https://gitlab.isae-supaero.fr/a.stevan/nob.rs) to run commands +- [`clap`](https://crates.io/crates/clap) to provide a nice and complete build API + +First, [install `cargo-script`](https://github.com/DanielKeep/cargo-script#installation). + +Then, run the script with `./make.rs --help` + ## the library -see `cargo doc` or [the library itself](src/) +```shell +./make.rs doc +``` ## the tests ```shell