Getting Started¶
Prerequisites¶
Compiler¶
msvc 16.10 is currently broken with boost::ut
Documentation prerequisites¶
Python Packages
Checkout the repository¶
git clone https://github.com/Sebanisu/OpenVIII_CPP_WIP.git --recursive
Build tests and applications¶
Run cmake¶
cd OpenVIII_CPP_WIP
mkdir build
If you only want tests and applications built
cmake -G "Ninja Multi-Config" -B build
If you want documentation built as well
cmake -G "Ninja Multi-Config" -B build -DDOCS:STRING=YES
You might need to clear out the docs directory before building. As it won’t overwrite some files if unless it detects a change. Documentation is checked in,
so it shows on GitHub pages. .nojekyl is required to work on GitHub pages, and cmake will generate it.
Run tests¶
ninja -C build test
For more verbose output
This is recommended, as most of the test framework print out extra info.
ninja -C build
cd build
ctest -C debug --verbose
cd ..
Open documentation¶
cd docs
# open index.html
Run applications¶
cd build
cd applications
# dir or ls
Windows MSVC - MSBuild¶
Run cmake¶
cd OpenVIII_CPP_WIP
mkdir build
cmake -G "Visual Studio 16 2019" -B build
Run tests¶
For more verbose output
MSBuild build\ALL_BUILD.vcxproj
cd build
ctest -C debug --verbose
cd ..
Windows MSVC - NMake¶
Load development environment¶
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat"
Run cmake¶
cd OpenVIII_CPP_WIP
mkdir build
cmake -G "CodeBlocks - NMake Makefiles" -B build
Run tests¶
For more verbose output
cmake --build build --target all
cd build
ctest -C debug --verbose
cd ..