Skip to content

docs: the first command names a file that exists #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mysma-9403 merged 1 commit into from
Oct 11, 2026
Merged

docs: the first command names a file that exists #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
```

Expand Down
Loading