Folder Structure¶
The generated project has the following folder structure
{{cookiecutter.cmake_project_name}}
├──azure-pipelines.yml # Ci script
│
├──benchmark # C++ benchmark code
│ └── ...
│
├──binder # dockerfile for mybinder.org
│ └── Dockerfile
│
├──cmake # Cmake script/modules
│ └── ...
│
├──CMakeLists.txt # Main cmake list
│
├──CONTRIBUTING.rst # Introduction how to constribute
│
├──{{cookiecutter.cmake_project_name}}Config.cmake.in # Script to make find_package(...)
│ # work for this package
│
├──{{cookiecutter.cmake_project_name}}.pc.in # Packaging info
│
├──{{cookiecutter.package_name}}-dev-requirements.yml # List of development conda dependencies
│
├──docker # dockerfile for dockerhub
│ └── Dockerfile
│
├──docs # Sources for sphinx documentation
│ └── ...
│
├──examples # C++ examples
│ └── ...
│
├──include # C++ include directory for this folder
│ └── ...
│
├──LICENCE.txt # License file
│
├──python # Python binding source code
│ └── ...
│
├──README.rst # Readme shown on github
│
├──readthedocs.yml # Entry point for automated
│ # documentation build on readthedocs.org
│
├──recipe # Folder for conda recipes
│ └── ...
│
└──test # Folder containing C++ unit tests
└── ...