readme.md

<project_name>

<project_description>

📃 Initial setup

• this project is generated using https://github.com/parthux1/project_preset
• run ./scripts/init_project.sh in project root to define common project variables using the following flags
  • -p project name
  • -d project description
  • see scripts/init_project.sh for more information

🛠️ Building with vcpkg

• clone with submodules to get vcpkg
• run bootstrap and install dependencies

this can be done by running

# run in project root
sh ./scripts/vcpkg_setup.sh

🗏 using CLI

Toolchain-File of Vcpkg is included in the CMakeLists.txt in the root dir. Build normally or by running

# run in project root
sh ./scripts/build.sh

🖥️ using Clion UI

Link the installed vcpkg instance to clion: View > Tool Windows > Vcpkg > + > [root dir]/tooling/vcpkg

📃 Documentation

You can generate a documentation using doxygen. This will include files from src/ and doc/source/.
Documentation will be written to doc/out/.

# run in project root
doxygen doc/DoxyFile

# open the documentation
start doc/out/html/index.html