diff --git a/README.md b/README.md index ce87c7a..ef43f4a 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,16 @@ Rust Flight Software Framework Launchpad This is the prototyping repository for the initial version of a Rust Flight Software Framework. + +## Build instructions + +### Prerequisites + +Do not forget to ```git submodule update --init```. +Also remember to ```git submodule update``` after each branch change or merge. + +### Build and run + +Then it is a simple ```cargo build``` then can be run using ```cargo run --bin ```. +Binaries are `obsw`, `client`, `test`. +