In order to build the project in debug mode, execute the following from the project root directory.
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Debug ..
$ make
VMF uses g++ as the default compiler, but will also support building with clang++. Simply comment in the appropriate line in CMakeLists.txt
#Clang or g++ are supported
#set(CMAKE_CXX_COMPILER g++)
set(CMAKE_CXX_COMPILER clang++)
To generate class level Doxygen documentation, run the following commands. (Doxygen must be installed first.)
cd docs/doxygen
doxygen Doxyfile.in
Open docs/doxygen/html/index.html to browse the resulting html documentation.
To rebuild the PDF version of the documentation, run the following additional commands:
cd docs/doxygen/latex
make
Open docs/doxygen/latex/refman.pdf to view the resulting PDF documentation.
Third party source libraries should be added to vmf/dependencies. There are three steps:
-
Modify or create a CMakeLists.txt file for the project. You may need to disable the project's install commands to avoid putting unwanted artifacts in our install.
-
Add the license information to vmf/dependencies/licences
-
Put the add_subdirectory() command in vmf/dependecies/CMakeLists.txt. In general, build the library as static where possible so it can be linked into a monolithic VMFFramework.so