directoryStructure.md

Directory structure

• mainProjectFolder
  • build - user created, build takes place here
    • dist - here builded application is copied (by deafult, see CMAKE_INSTALL_PREFIX in main CMakeLists.txt)
      • bin
      • share
        • data - here folder data is copied
      • doc
        • doxygen lives here documentation
  • cmake - contains cmake scripts that can be included with include()
    • cleanCppExtensions.cmake - reusable helpers for source/CMakeLists.txt
    • sanitizers.cmake - adds sanitizers options
    • useGoldLinker.cmake - enables simple use of gold linker for faster linkage
  • data - contain data
  • doc - contains documentation
    • CMakeLists.txt - doc building
    • doxygen
      • doxygen settings, and modern style config
  • packaging
    • CMakeLists.txt - package creation
    • exampleApp.desktop - linux shortcut (app is then visible in launchers)
    • exampleApp.png - icon for linux shortcut
    • exampleApp.icon.in.rc - icon for windows description file (used in source/CMakeLists.txt)
    • exampleApp.ico - icon for windows shortcut (linked via exampleApp.icon.in.rc into the executable)
  • source - contain source files
    • CMakeLists.txt - source building
    • .ycm_extra_conf.py - for ycm smart autocompletion
    • *unittest contains unittest build
      • CMakeLists.txt - unittest building
      • testmain.cpp - main unit tests function
  • test - integration tests, CTest, data sets for tests and unit tests
    • CMakeLists.txt - tests specification
  • external
    • CMakeLists.txt - external projects handling (eg. Download of Catch and examples to do more)
  • readme.md - main readme file
  • CMakeLists.md - Main CMake configuration
  • .clang-format - clang format config file
  • .clang-tidy - clang tidy config file
  • .travis.yml - continuous integration configuration for Travis CI
  • .gitlab-ci.yml - continuous integration configuration for Gitlab CI