From 1470e02a441f524643bf093546e1a24f4fff11b3 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 31 May 2021 17:03:22 +0200 Subject: [PATCH] added config chapter --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc02c8b..6a5ad9a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# FSFW Demo Application +# FSFW Example Application This repository features a demo application. The example has been run successfully on the following platforms: @@ -20,7 +20,17 @@ and running as expected. The repository contains a Python TMTC program which can be used to showcase the TMTC capabilities of the FSFW (currently, using the ECSS PUS packet standard). - + +# Configuring the Example + +The build system will copy three configuration files into the build directory: + +1. `commonConfig.h` which contains common configuration parameters +2. `OBSWConfig.h` which can contain machine and architecture specific configuration options +3. `FSFWConfig.h` which contains the configuration for the flight software framework + +These files can be edited manually after `CMake` buld generation. + ## Reference [Getting started with the Linux OSAL](doc/README-linux.md#top)