From f52ab3a2c3b348e4eb262f1fa09cff64e804d0a9 Mon Sep 17 00:00:00 2001 From: Maciej Myszkiewicz Date: Sun, 11 Oct 2026 09:59:50 +0200 Subject: [PATCH] docs: the first command names a file that exists `xtce-flight generate mission.xml` asks for a definition the repository does not have, from a binary a clone has not built. Both now point at what is there: testdata/flight_shapes.xml is where the StatusReport in the block below is generated from, so the two examples became one example. `cargo test --workspace` is 42 tests, not 32. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1e65e39..a5a0779 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,13 @@ rule against a code path that can panic. The generators that produce that half a inside the companies that fly and stay there. ```console -$ xtce-flight generate mission.xml -o telemetry.rs +$ cargo run --release -p xtce-flight -- generate testdata/flight_shapes.xml -o telemetry.rs ``` +That definition ships with the repository and is where the `StatusReport` below comes from, so +the two blocks are one example. `cargo install --path crates/xtce-flight` puts the command on +your `PATH` as `xtce-flight` if you would rather type that. + ```rust // Every field the definition leaves free, and only those: VERSION and PKT_APID are // absent because the restriction criteria fix them. @@ -250,7 +254,7 @@ no mission definition in reach has a 16-bit float at all. ## Testing ```console -$ cargo test --workspace # 32 tests, no Python needed +$ cargo test --workspace # 42 tests, no Python needed $ ./scripts/check-no-panic.sh # the bare-metal gate ```