From 00042af77c99fc9dd7a6bc880e02b25a86658527 Mon Sep 17 00:00:00 2001 From: Ulrich Mohr Date: Thu, 10 Feb 2022 15:27:03 +0100 Subject: [PATCH] updated README to cmake changes --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7d27b092..54af1c93 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ When using Windows, run theses steps in MSYS2. ```sh mkdir build-Debug-Q7S && cd build-Debug-Q7S - cmake -DTGT_BSP="arm/q7s" -DCMAKE_BUILD_TYPE=Debug -DOS_FSFW=linux .. + cmake -DTGT_BSP="arm/q7s" -DCMAKE_BUILD_TYPE=Debug .. cmake --build . -j ``` @@ -120,8 +120,7 @@ When using Windows, run theses steps in MSYS2. This will invoke a Python script which in turn invokes CMake with the correct arguments to configure CMake for Q7S cross-compilation. - You can build the hosted variant of the OBSW by replacing `-DOS_FSFW=linux` with - `-DOS_FSFW=host`. There are also different values for `-DTGT_BSP` to build for the Raspberry Pi + There are also different values for `-DTGT_BSP` to build for the Raspberry Pi or the Beagle Bone Black: `arm/raspberrypi` and `arm/beagleboneblack`. 5. Build the software with @@ -160,38 +159,45 @@ automatically. ### Q7S OBSW +The EIVE OBSW is the default target if no target is specified. + ```sh mkdir build-Debug-Q7S && cd build-Debug-Q7S -cmake -DTGT_BSP=arm/q7s -DFSFW_OSAL=linux -DCMAKE_BUILD_TYPE=Debug .. +cmake -DTGT_BSP=arm/q7s -DCMAKE_BUILD_TYPE=Debug .. cmake --build . -j ``` ### Q7S Watchdog +To build the EIVE watchdog, the corresponding target must be specified in the build command. +The configure steps do not need to be repeated if the folder has already been configured. + ```sh mkdir build-Debug-Q7S && cd build-Debug-Q7S -cmake -DTGT_BSP=arm/q7s -DFSFW_OSAL=linux -DEIVE_BUILD_WATCHDOG=ON -DCMAKE_BUILD_TYPE=Debug .. -cmake --build . -j +cmake -DTGT_BSP=arm/q7s -DCMAKE_BUILD_TYPE=Debug .. +cmake --build . --target eive-watchdog -j ``` ### Hosted -You can also replace `linux` by `host` for this command to build on Windows or for generic OSes +You can also use the FSFW OSAL `host` to build on Windows or for generic OSes. +Note: Currently this is not supported. ```sh mkdir build-Debug-Host && cd build-Debug-Host -cmake -DFSFW_OSAL=linux -DCMAKE_BUILD_TYPE=Debug .. +cmake -DFSFW_OSAL=host -DCMAKE_BUILD_TYPE=Debug .. cmake --build . -j ``` ### Unittests -You can also replace `linux` by `host` for this command to build on Windows +To build the unittests, the corresponding target must be specified in the build command. +The configure steps do not need to be repeated if the folder has already been configured. ```sh mkdir build-Debug-Unittest && cd build-Debug-Unittest -cmake -DFSFW_OSAL=linux -DEIVE_BUILD_UNITTESTS=ON .. -cmake --build . -j +cmake .. +cmake --build . --target eive-unittests -j ``` ## Connect to EIVE flatsat @@ -1163,4 +1169,4 @@ in the same way. 5. Navigate to Preferences → C/C++ → CppStyle 6. Insert the path to the clang-format executable 7. Under C/C++ → Code Style → Formatter, change the formatter to CppStyle (clang-format) -8. Code can now be formatted with the clang tool by using the key combination Ctrl + Shift + f \ No newline at end of file +8. Code can now be formatted with the clang tool by using the key combination Ctrl + Shift + f