Introduction, compiling and structure

Welcome to the RoFI project. In this chapter we will give you the basic overview on the sources & data organization in the repository. We will also show you, how to compile the project.

First, start by cloning the project repository:

$ git clone https://github.com/paradise-fi/RoFI.git
$ git clone git@github.com:paradise-fi/RoFI.git # If you have SSH keys set up

Then proceed to the following sections:

• RoFI Compilation
  • Build environment
  • Compilation suites
    • Desktop Suite
      • Dependencies
      • Build options
    • Documentation Suite
      • Dependencies
      • Build options
  • Compilation targets
  • Flashing robots and hardware modules
  • Advanced configuration of the build process
  • Quick start example
  • Quick start Simulator example
    • GazeboSim
    • SimpleSim
    • Module code
• Project Structure
• Writing and running tests
  • Running the test
  • Writing tests
  • Writing test for C++