nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 00:44:37 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

Update Ref Application README (#3423)

Browse Source
This commit is contained in:
Tyler Russin 2025-03-28 12:47:57 -04:00 committed by GitHub
parent 795abf02db
commit c7828f504d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Ref/README.md
View File

@ -14,12 +14,28 @@ Please follow the [install guide for F´](../docs/getting-started/installing-fpr
## Building and Running the Ref Application
In order to build the Ref application, or any other F´ application, we first need to generate a build directory. F´ uses CMake under the hood,
To get started with creating the Ref application we will first need to clone the nasa/fprime repository. We then can change directories into the project's
Ref directory so that we have a place to build the Ref application.
```
git clone https://github.com/nasa/fprime
cd fprime/Ref
```
With the repository cloned and the project's Ref directory entered we can now create a python virtual environment, activate that environment, and then
install the project requirements.
```
python3 -m venv fprime-venv
. fprime-venv/bin/activate
pip install -r ../requirements.txt
```
In order to build the Ref application, or any other F´ application, we need to generate a build directory. F´ uses CMake under the hood,
which requires a directory to work in. To generate a build directory, we will use the `fprime-util` (a wrapper for CMake to streamline standard
F´ processes). This can be done with the following commands:
```
cd fprime/Ref
fprime-util generate
```