Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 3.22 KB

NewProject.md

File metadata and controls

96 lines (72 loc) · 3.22 KB
Raw

Hello World: Creating an F´ Project

This tutorial will walk new users through creating a new F´ project.

Tutorial Steps:

Bootstrapping F´

An F´ project ties to a specific version of tools to work with F´. In order to create this project and install the correct version of tools, an initial bootstrap version of F´ tools must be installed. This is accomplished with the following command:

pip install fprime-tools

Creating a New F´ Project

Now that the tools are installed a new F´ project should be created. An F´ project internalizes the version of F´ that the project will build upon and provides the user the basic setup for creating, building, and testing components.

In order to make a new project, run the following command:

fprime-util new --project

This command will ask for some input. Respond with the following answers:

project_name [MyProject]: MyProject
fprime_branch_or_tag [devel]: devel
Select install_venv:
1 - yes
2 - no
Choose from 1, 2 [1]: 1

Use the default for anything not specified. This command will take a moment to run as it needs to clone the core F´ repository.

The above command creates a new F´ project structure in a folder called MyProject, uses the devel branch of F´ as the basis for the project, and sets up the matching tools in a new Virtual Environment.

We should navigate to the projects's directory and look around:

cd MyProject
ls

This will show the following files:

  1. fprime/: F´ repository. Contains core F´ components, the API for the build system, among others
  2. settings.ini: allows users to set various settings to control the build
  3. CMakeList.txt and project.cmake: CMake files defining the build system
  4. Components/: directory to place user components in

Load the tools for this project via the virtual environment.

# In: MyProject
. venv/bin/activate

Make sure to load these tools any time you are working with the this project.

Building the New F´ Project

The next step is to set up and build the newly created project. This will serve as a build environment for any newly created components, and will build the F´ framework supplied components.

cd MyProject
fprime-util generate
fprime-util build -j4

fprime-util generate sets up the build environment for a project/deployment. It only needs to be done once.

Conclusion

A new project has been created with the name MyProject and has been placed in a new folder called MyProject in the current directory. It includes the initial build system setup, and F´ version. It is still empty in that the user will still need to create components and deployments.

For the remainder of this Hello World tutorial we should use the tools installed for our project and issue commands within this new project's folder:

# In: MyProject
. venv/bin/activate

Use this command if your virtual environment is not already running.

Next: Hello World: Creating an F´ Hello World Component