From 6ebc8bbd8590593fa8a13ec6e0c1e163ff171374 Mon Sep 17 00:00:00 2001
From: STEVAN Antoine <antoine.stevan@isae-supaero.fr>
Date: Thu, 10 Apr 2025 11:24:29 +0000
Subject: [PATCH] update the readme (dragoon/komodo!206)

This MR explains the use of `make.rs` and `nob.rs` in the README for newcomers.
---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eff6db1d..48d91045 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,19 @@
 [![source](https://gitlab.isae-supaero.fr/dragoon/komodo/badges/main/pipeline.svg?key_text=GitLab%20CI)](https://gitlab.isae-supaero.fr/dragoon/komodo/-/pipelines)
 [![mirror](https://github.com/dragoon-rs/komodo/actions/workflows/ci.yml/badge.svg)](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
-- 
GitLab