Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 2.49 KB

README.md

File metadata and controls

96 lines (69 loc) · 2.49 KB
Raw

imgui-serial

IMGUI + SDL2 serial port application for SPC Player Arduino project. This project is a work in progress! Project supports both Linux and Windows and on Windows compilation requires MSYS2 environment.

Prerequisites

After cloning this repository, you need to clone the Git submodules, by default submodules are not cloned initially. Do this by running following in a project directory:

git submodule init
git submodule udate

You system also need to have OpenGL drivers installed for your GPU. On Linux Mesa for example. Check your systems package manager for it. Usually these are already installed some way or other and no need to install anything.

Build

Windows MSYS2/MinGW

On Windows I have tested this project with MinGW64 shell, that is shipped with MSYS2 installation.

First you need to install SDL2 and Boost libraries. To do that run:

pacman -S mingw-w64-i686-SDL2 mingw-w64-x86_64-boost

When building with MSYS2. Make sure you install MinGW version of CMake mingw-w64-x86_64-cmake. This will ensure that you are building for Windows. You also need to install the tool for actual building. By default Ninja is used if generator for the CMake is not specified. Install Ninja from mingw-w64-x86_64-ninja. For further information check CMake forMSYS2.

Install above packages with:

pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja

To build the application, run following commands in the project folder. Debug build is compiled by default, if you want a release build, please add -DCMAKE_BUILD_TYPE=Release to first CMake command.

mkdir build && cd build
cmake ..
cmake --build .

Linux

You need to install SDL2 and Boost libraries for your system. On Arch Linux for example:

sudo pacman -S sdl sdl2 boost

To build the application, run following commands in the project folder. Debug build is compiled by default, if you want a release build, please add -DCMAKE_BUILD_TYPE=Release to first CMake command.

mkdir build && cd build
cmake ..
cmake --build .

Running

After everything compiles, executable spc_player will be placed under your build directory. Run it from the build folder with:

./spc_player

Tests

After successful build, in the build folder simple execute:

ctest

Another way is to execute the test are the other executables under build/bin folder.