Currently, the only tested IDE is VSCode. If you get another to work, please document the environment setup here. Note that this process can be followed on the Raspberry Pis if needed.
The following plugins are needed for use with VSCode. These can be downloaded under the extensions tab.
- C/C++ Extension Pack
- CMake
- CMake Tools
Follow these instructions to create an SSH key. When asked what to name the file, press enter. This will give the file the default name. When asked to create a password, press enter. You may stop when you reach the section titled "Generating a new SSH key for a hardware security key". To add the key to your account, follow these directions, starting in the "Adding a new SSH key to your account" section. To validate this was successful, run the following command:
ssh git@github.comWhen asked to confirm the key, type yes and press enter.
To download the project, first navigate to the desired download location and open a terminal. After this, run the following command:
git clone git@github.com:HEEV/SupermilageDisplay.git --recursiveTo download libusb, run the following commands:
sudo apt update && \
sudo apt install libusb-1.0-0-dev -yInstall GCC or clang as well as cmake. Note that the compiler must support C++20. Currently, the version of clang installed by apt is not supported. CMake must be at least version 3.15.
Follow the instructions in this JUCE documentation. Depending on your distribution, OpenSSL mat also be required. Ubuntu comes with this be default.
The project is ready to be compiled! To do so, click on the play button at the bottom of the screen (VScode) or at the top (Visual Studio). Note that the play button at the top right in VSCode will not work.