Cookiecutter Empirical Project

Cookiecutter template for an Empirical Project. Take a look at a live example of an instantiated template here.

• GitHub repo: https://github.com/devosoft/cookiecutter-empirical-project/
• Free software: MIT LICENSE

An offshoot of the Empirical C++ Library.

Features

• GitHub Actions: Ready for Continuous Integration testing and deployment with GitHub actions.
• Github Pages: Auto-deploy your web application (like this).
• Sphinx docs: Documentation ready for generation and deployment with, for example, ReadTheDocs.
• Bumpversion: Pre-configured version bumping with a single command.

Quickstart

Install the latest Cookiecutter if you haven't installed it yet::

pip install -U cookiecutter

Generate an Empirical project:

cookiecutter https://github.com/devosoft/cookiecutter-empirical-project.git

hooks/post_gen_project.sh will run to initialize submodules. If you want your repo to automatically push to github, set up the remote repo first.

Take it for a spin!

make test

Then add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.