cpp_project_template

Getting Started

Usage

First, create a repository from this github template by using the Use this template button. Fill in the necessary details and clone. After cloning the repository remove any unneeded frameworks using git rm: $ git rm -r ./path/to/framework

Dependencies

Necessary Dependencies

1. A C++ compiler that supports C++17. See cppreference.com to see which features are supported by each compiler. The following compilers should work:

   • gcc 7+
   • clang 6+
   • Visual Studio 2019 or higher

2. Conan

3. CMake 3.15+

Optional Dependencies

C++ Tools

• Doxygen
• ccache
• include-what-you-use
• Cppcheck
• clang-tidy

Testing

• See Catch2 tutorial
• See Google Test
• See libFuzzer Tutorial

GUI libraries

This project can be made to work with several optional GUI frameworks.

If desired, you should install the following optional dependencies as directed by their documentation, linked here:

• FLTK
• GTKMM
• QT

The following dependencies can be downloaded automatically by CMake and Conan. All you need to do to install them is to turn on a CMake flag during configuration. If you run into difficulty using them, please refer to their documentation, linked here:

• IMGUI: This framework depends on SFML, and if you are using Linux, you may need to install several of SFML's dependencies using your package manager. See the SFML build tutorial for specifics.

Acknowledgments

This template is an adaption of the one from lefticus. Refer to it for a more comprehensive template.