Files
op-pedal/docs/TheBuildSystem.md
T
2022-03-07 03:54:32 -05:00

1.3 KiB

The Build System

PiPedal was developed using Visual Studio Code. Using Visual Studio Code to build PiPedal is recommended, but not required. The PiPedal build procedure uses CMake project files, which are supported by most major Integrated Development Environments.

If you open the PiPedal project as a folder in VS Code, Code will detect the CMake configuration files, and automatically configure the project to use available toolchains. Once the VS Code CMake plugin (written by Microsoft, available through the plugins store) has configured itself, build commands and configuration options should appear on the bottom line of Visual Studio Code.

If you are not using Visual Studio Code, you can configure, build and install PiPedal using CMake build tools. For your convenience, the following shell scripts have been provided in the root of the project.

./init    # Configure the CMake build (required if you change one of the CMakeList.txt files)

./mk   # Build all targets.

sudo ./install   # Deploy all targets 

sudo ./makePackage    # Build a .deb file for distribution.

If you are using a development environment other than Visual Studio Code, it should be fairly straightforward to figure out how to incorporate the PiPedal build procedure into your IDE workflow by using the contents of the build shell scripts as a model.