Link Search Menu Expand Document

Usage

This project is built using Cmake and Makefiles in order to allow users to easily run our code and tets it.
Please follow these necessary steps:

  1. Clone the project with:
    git clone https://github.com/OmarJabri7/Cycle_Buddy.git
  2. Change directorites and relocate in Cycle_Buddy project:
    cd Cycle_Buddy
  3. Make Build directory containing all executables:
    mkdir build && cd build
  4. Link the necessary executables and libraries using CMake (in build dir):
    cmake ..
  5. Build the project using make (in build dir):
    make
  6. Before Testing and Running the system:
    Be sure to either use our GPIO setup, or change to your own in:
    GPIO numbering
  7. Generate Unit tests and check if all components pass (in build dir):
    make test
  8. Go to main directory: cd ..
  9. Make sure you have permissions to execute run.sh:
    chmod +x run.sh
  10. Run the bash script labeled run.sh:
    ./run.sh


For more information, please visit this: