HulaLoop¶

Important Commands¶

A rough set of commands needed to build the project.

Git¶

Clone the project:

git clone --recurse-submodule https://github.com/symboxtra/HulaLoop

Update an already cloned submodule:

git submodule update --remote --merge

Dependencies¶

Debian-based Linux¶

Required:

sudo apt install g++ build-essential libgl1-mesa-dev cmake libasound2 libasound2-dev

IMPORTANT: Qt must be installed using the GUI installer since apt does not backport a recent enough version.

If you want to compile documentation:

sudo apt install python3-sphinx doxygen graphviz
python -m pip install recommonmark

OSX¶

Install brew:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

brew install g++ qt build-essential cmake portaudio

IMPORTANT: JACK2 must be installed using the GUI installer since brew only includes JACK1.

If you want to compile documentation:

brew install sphinx-doc doxygen graphviz
python -m pip install recommonmark

Windows¶

Install Qt
Install CMake
Install Visual Studio or the MSVC build tools
Good luck…

CMake¶

mkdir build
cd build
cmake ..
cmake --build .
./bin/<executable name>

CTest¶

cd build
ctest -C Debug -V

Build Tutorials and Documentation¶

cd docs
make html # Runs Doxygen and Sphinx builds
cd build-docs/html
# python -m SimpleHTTPServer is a simple way to serve these
# Open localhost:8000 in your browser to view

Build Developer Documentation¶

This is built with the first option. To build separetly, use:

cd docs
doxygen # Finds default Doxyfile
cd build-doxygen/html