More information TODO
Workflow | Status |
---|---|
Documentation | |
Docker Testing |
- Doxygen (In order to build documentation)
- Catch2 (In order to build tests)
- Gurobi (In order to build some optimizers)
- OpenGL (In order to build graphics)
- GLFW (In order to build graphics)
- FreeType (In order to build graphics)
If all dependencies are installed, you can execute the following commands at the top-level directory to build this repository. These instructions have only been tested on Ubuntu 18.04.
mkdir build
cd build
cmake ..
make
The CMakeLists.txt
at the root of this repository supports the following
options, which can be supplied during the build process to affect which parts
of the repository get built.
-
-DCANNON_BUILD_GRAPHICS=<ON/OFF>
--- Whether to build thegraphics
package. -
-DCANNON_BUILD_RESEARCH=<ON/OFF>
--- Whether to build theresearch
package. This option should always remain OFF (the default) unless you have access to my private research repository. -
-DCANNON_BUILD_DOC=<ON/OFF>
--- Whether to build Doxygen documentation for this repository. -
-DCANNON_BUILD_LIBRARY=<ON/OFF>
--- Whether to build thecannon
library. -
-DCANNON_BUILD_SCRIPTS=<ON/OFF>
--- Whether to build script executables.