From af49c80341bf0cd0db48dd82884d22a0691c5f3f Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 7 Feb 2024 18:09:15 +0100 Subject: [PATCH] another small update --- satrs-example/README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/satrs-example/README.md b/satrs-example/README.md index c78c08f..3447a0d 100644 --- a/satrs-example/README.md +++ b/satrs-example/README.md @@ -10,16 +10,7 @@ the sat-rs book. The application opens a UDP and a TCP server on port 7301 to receive telecommands. -You can run the application using `cargo run`. The `simpleclient` binary target sends a -ping telecommand and then verifies the telemetry generated by the example application. -It can be run like this: - -```rs -cargo run --bin simpleclient -``` - -This repository also contains a more complex client using the -[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module. +You can run the application using `cargo run`. # Features @@ -33,7 +24,22 @@ You can run the application without this feature using cargo run --no-default-features ``` -# Using the tmtccmd Python client +# Interacting with the sat-rs example + +## Simple Client + +The `simpleclient` binary target sends a +ping telecommand and then verifies the telemetry generated by the example application. +It can be run like this: + +```rs +cargo run --bin simpleclient +``` + +This repository also contains a more complex client using the +[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module. + +## Using the tmtccmd Python client The python client requires a valid installation of the [tmtccmd package](https://github.com/robamu-org/tmtccmd). @@ -66,7 +72,3 @@ the `simpleclient`: ``` You can also simply call the script without any arguments to view the command tree. - -# High-level information about the example project - -You can read more high-level information inside the [dedicated chapter]() of the sat-rs book.