Installation Guide

Setting up the Core Flight System (cFS) involves cloning the main bundle repository and initializing all the necessary component submodules. This guide walks you through the process as described in the project's README.md file.

Prerequisites

Before you begin, ensure you have the following software installed on your system:

make
cmake
A C compiler suite (e.g., gcc)
git

Setup Instructions

Follow these steps to set up the cFS development environment in your desired working directory.

Clone the cFS Bundle Repository

This command downloads the main cFS repository, which contains the submodule definitions.
```
git clone https://github.com/nasa/cFS.git
```
Navigate into the Project Directory
```
cd cFS
```
Initialize the Submodules

This command initializes your local configuration file to recognize the submodules defined in .gitmodules.
```
git submodule init
```
Update and Clone the Submodules

This command fetches the latest code from each submodule repository (like cFE, OSAL, PSP, etc.) and checks out the correct commit specified in the main cFS repository. This step may take some time as it downloads all the necessary components.
```
git submodule update
```
Copy Default Build Files

cFS uses a sample Makefile and a set of sample build definitions to get started. Copy these into the root of the project.
```
cp cfe/cmake/Makefile.sample Makefile
cp -r cfe/cmake/sample_defs sample_defs
```

After completing these steps, your environment is set up and ready for building the software. Proceed to the Quick Start Guide to compile and run cFS.