This project is a Cookiecutter template for creating a C++ library project, with tooling.
The main features of the C++ project are:
- CMake build system
- Google Test for C++ unit tests
$ pip3 install cookiecutter
$ cookiecutter https://github.com/nmusolino/cookiecutter-cpplib-tools
You will be prompted to enter an author name, a project name, and other template parameters. The main parameters are listed in the table below.
| Template parameter | Usage |
|---|---|
| full_name | Author name. Used in copyright notices and README file. |
| project_name | Name of project. Used in documentation. |
| project_slug | Short name of project, used in filenames. Should not include whitespace. |
| library_name | Used in C++ library name, which will be lib<library_name>. |
| cpp_namespace | Namepsace used in C++ files: namespace <cpp_namespace> { ... } |
$ cd my_project
$ mkdir build
$ cd build
$ cmake ..
$ cmake --build .
$ ctest # run C++ unit tests
To contribute to this cookiecutter template project, check out the repository and run the tests.
$ git clone https://github.com/nmusolino/cookiecutter-cpplib-tools
$ cd cookiecutter-cpplib-tools
$ pip3 install pipenv
$ pipenv install --dev
$ pipenv run pytest # Run tests of the template
This project is licensed under the GNU General Public License, version 3. See the LICENSE file for details.