shawn/op-pedal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs improvements,

Browse Source
This commit is contained in:
Robin Davies
2022-08-19 08:02:09 -04:00
parent b6ea1fd72b
commit 3f78857363
18 changed files with 3086 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/TheBuildSystem.md
+7 -4
View File
@@ -1,17 +1,20 @@
### 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.
build procedure uses CMake project files, which are supported by most major Integrated Development Environments. You will probably
need at least 8Gb of memory to use Visual Studio Code. You can probably build PiPedal from the command-line using 2Gb. If you have
4Gb of memory, you may be able to build using Visual Studio Code remote compilation and remote debugging. If you try this, we would
be grateful if you could share your experience on the [PiPedal discussion pages](https://github.com/rerdavies/pipedal/discussions).
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.
available through the Code plugins store) has configured itself, build commands and configuration options should appear on the bottom status 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)
./init # Configure the CMake build (first time, or if you
# have changed one of the CMakeList.txt files)
./mk # Build all targets.