Skip to content

Commit 9907f03

Browse files
committed
[docs] Clarify development instructions
1 parent 9ec74e0 commit 9907f03

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

docs/development.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ git submodule update --init
1010

1111
## Running and testing
1212

13-
The CLI and Rust tests run with `cargo run` and `cargo test`.
13+
The CLI runs with `cargo run -- <CLI_ARGS>`, and Rust-based tests run with
14+
`cargo test`.
1415

15-
Many test cases are written as Python integration tests, in order to use the
16+
Many of the most important test cases are written as Python-based integration
17+
tests instead of Rust tests, in order to use the
1618
[garmin-fit-sdk](https://pypi.org/project/garmin-fit-sdk/) Python package as a
1719
reference implementation for FIT decoding. Run these with
1820
[uv](https://docs.astral.sh/uv/):
@@ -22,7 +24,8 @@ uv run --package integration pytest
2224
```
2325

2426
Some of the integration tests use the nested `integration-stub` binary crate
25-
by passing JSON specifications to it and then examining its output.
27+
by passing JSON specifications to it and then examining its output. Most
28+
others build and test against the `coursepointer` command-line binary.
2629

2730
## Formatting
2831

0 commit comments

Comments
 (0)