From a704986d74d667fe37ef2244ef8561f3e0d405db Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 9 Jan 2023 14:50:03 +0100 Subject: [PATCH] update README --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 403189d6..19197bfa 100644 --- a/README.md +++ b/README.md @@ -290,7 +290,7 @@ helper scripts as well. 4. Run build command by double clicking the created target or by right clicking the project folder and selecting Build Project. -# Useful and Common Commands (Host) +# Useful and Common Commands ## Build generation @@ -319,14 +319,9 @@ cmake -DTGT_BSP=arm/q7s -DCMAKE_BUILD_TYPE=Release .. cmake --build . -j ``` -### Q7S Watchdog - -The watchdog will be built along side the primary OBSW binary. - -### Hosted +### Hosted OBSW You can also use the FSFW OSAL `host` to build on Windows or for generic OSes. -Note: Currently this is not supported. ```sh mkdir cmake-build-debug && cd cmake-build-debug @@ -334,6 +329,21 @@ cmake -DFSFW_OSAL=host -DCMAKE_BUILD_TYPE=Debug .. cmake --build . -j ``` +You can also use the `linux` OSAL: + +```sh +mkdir cmake-build-debug && cd cmake-build-debug +cmake -DFSFW_OSAL=linux -DCMAKE_BUILD_TYPE=Debug .. +cmake --build . -j +``` + +Please note that some additional Linux setup might be necessary. +You can find more information in the [Linux section of the FSFW example](https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-linux-mcu/src/branch/mueller/master/doc/README-linux.md#raising-message-queue-size-limit) + +### Q7S Watchdog + +The watchdog will be built along side the primary OBSW binary. + ### Unittests To build the unittests, the corresponding target must be specified in the build command.