fsfw/fsfw-example-hosted
fsfw
/
fsfw-example-hosted
12
1
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

updated README

This commit is contained in:
Robin Müller 2021-06-09 11:30:59 +02:00
parent 09ab2dfee4
commit ba3b767f15
No known key found for this signature in database
GPG Key ID: 9C287E88FED11DF3
1 changed files with 12 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -118,6 +118,8 @@ the "MinGW Makefiles" generator in Windows in the command line to be as generic
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug -DOS_FSFW=host ..
```
You can also use `-DOS_FSFW=linux` to use the Linux OSAL of the FSFW.
3. Build the software
```sh
cmake --build . -j
@ -162,32 +164,6 @@ as well to have a convenient way to configure the CMake build.
5. Like already mentioned, it is recommended to run the binary directly as an executable by
double-clicking it or in the Windows Terminal.
## Building the Software with Makefiles
The Makefile is able to determine the OS and supply additonal required libraries,
but this has only been tested for Windows 10 and Linux (Ubuntu 20.04)
1. Clone this repository
```sh
git clone https://egit.irs.uni-stuttgart.de/fsfw/fsfw_example.git
```
2. Set up submodules
```sh
git submodule init
git submodule update
```
3. Copy the `Makefile-Hosted` file in the `make` folder into the cloned folder root
and rename it to `Makefile`
4. Once all the prerequisites have been met. the binary can be built with the following command.
Replace `debug` with `release` to build the optimized binary.
```sh
make debug -j
```
## Setting up Eclipse for CMake projects
The separate [Eclipse README](https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-common/src/branch/master/doc/README-eclipse.md) specifies how to set up Eclipse to build CMake