From c5a9b59145f4232a3231c6193be4b09b283d4972 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 18 Oct 2021 18:06:53 +0200 Subject: [PATCH] update README --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61141b8..82602be 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,14 @@ This demo provides the opportunity to to test functionality of the FSFW on a host computer without the need of setting up external embedded hardware. ## Prerequisites + 1. Makefile build: make installed (bundled with MSYS2 on Windows or via [xPacks Windows Build Tools](https://xpack.github.io/windows-build-tools/install/)). Natively installed on Linux. 2. Recommended for application code development: [Eclipse for C/C++](https://www.eclipse.org/downloads/packages/) . Project files and launch configuration are provided for Eclipse to ease development. Visual Studio support might follow soon following CMake implementation. -3. CMake Build: Correct CMake installation. +3. CMake Build: Correct CMake installation +4. Recommended: Python 3 and [just](https://github.com/casey/just) installed for easy build + generation ### Windows - MinGW64 build @@ -97,6 +100,35 @@ specifies some steps required to cleanly run the FSFW. ## Building the Software with CMake +### Recommended way using the `Justfile` and Python + +You can use the `Justfile` provided to get a list of common build targets and generate +the correct build configuration. Install [Python 3](https://www.python.org/downloads/) +first. The easiest way to install [just](https://github.com/casey/just) is to install +[Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) first and the run +the following command + +```sh +cargo install just +``` + +After that, you can display common build targets with + +```sh +just -l +``` + +and create a build configuration with + +```sh +just +``` + +All commands run will be display + + +### Manual Way using CMake + CMake should be [installed](https://cmake.org/install/) first. More detailed information on the CMake build process and options can be found in the [CMake README](https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-common/src/branch/master/doc/README-cmake.md).