diff --git a/README.md b/README.md index ae2cbf8..492f072 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ You can also find some more general documentation about OPS-SAT there. [podman](https://podman.io/) installed - [`cross`](https://github.com/cross-rs/cross) package installed -## Build +## Build for Target Hardware You might need to set the [`CROSS_CONTAINER_ENGINE`](https://github.com/cross-rs/cross/wiki/FAQ#explicitly-choose-the-container-engine) and [`CROSS_ROOTLESS_CONTAINER_ENGINE`](https://github.com/cross-rs/cross/blob/main/docs/environment_variables.md#configuring-cross-with-environment-variables) @@ -29,6 +29,23 @@ cross build cross build --release ``` +## Build for Host + +The software was designed to be runnable and testable on a host computer. +You can use the regular cargo workflow for this. + +### Running + +```sh +cargo run +``` + +### Testing + +```sh +cargo test +``` + ## Commanding Infrastructure Commanding of the `ops-sat-rs` application is possible by different means.