Setting up Wave

Dependencies

Compiling Wave requires the following dependencies to be installed:

Doxygen and Sphinx are only required for building the documentation (what you’re seeing now). See Building.

Getting a C++ toolchain

On Linux

You should already have GCC pre-installed.

On Mac

Open a Terminal instance by searching for it in Spotlight. Then enter the following command:

xcode-select --install

On Windows

  1. Download Visual Studio 2019 Community from here.

  2. In the installer, make sure to select the ‘Desktop Development with C++’ component.

Getting CMake

Download and install the correct binary distribution of CMake for your platform from here.

Getting Python

Download Python from here.

Getting Doxygen

Doxygen is not required if you do not want to build the documentation. Download the right version of Doxygen from here.

Getting Sphinx

Sphinx is not required if you do not want to build the documentation.

  1. Open a terminal window. On Mac, search it in Spotlight, and on Windows, search for ‘Command Prompt’.

  2. Enter the following command (requires Python):

pip install -U Sphinx

Cloning

If you have Git simply call:

git clone https://github.com/SparkyPotato/Wave --recursive

Or else, you can head over to GitHub, and download the repository by clicking on ‘Code’ and then ‘Download ZIP’.

Building

Note

If you do not wish to build the documentation, you do not need to install Doxygen or Sphinx. To disable documentation building, add the option -nodoc while invoking Build.py

  1. Open another terminal window, and navigate into the Wave directory you just cloned. On Windows, you can click on the path in File Explorer and type cmd to open a Command Prompt in the current directory.

  2. To quickly get up and running, just call:

python3 Build.py

If you want to know all the options you can set in the build script, call:

python3 Build.py -h