Cookiecutter template for an Empirical Project.
- GitHub repo: https://github.com/devosoft/cookiecutter-empirical-project/
- Free software: MIT LICENSE
An offshoot of the Empirical C++ Library.
- Travis-CI: Ready for Travis Continuous Integration testing.
- 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.
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
Get set up a repo on Github & make some git goodness happen:
cd your-cut-project
git init
git add .
git submodule add https://github.com/philsquared/Catch.git third-party/Catch
git submodule add -b master https://github.com/devosoft/Empirical.git third-party/Empirical
git commit -m "Initial commit"
git submodule init
git submodule update
git remote add origin git@github.com:yourusername/your-cut-project.git
git push origin master
-b master
above.
Take it for a spin!
make test
Then:
- If you haven't already, link your GitHub account to Travis CI.
- The repo might start building on Travis automatically, but if it doesn't add it manually.
- To enable automatic GitHub pages deployment, store a secret GithHub access token to the Travis-CI environment variable
GH_TOKEN
.- Select the
repo
(Full control of private repositories
) scope. ‼️ Be sure to keep a copy on hand for the next step!
echo GH_TOKEN=my_github_token | travis encrypt --no-interactive --com --add
- You'll need Travis-CI's Ruby gem (
sudo gem install travis
).
git add .travis.yml -m "Add GH_TOKEN var to Travis env" && git push origin master
- Once Travis builds, your site should deploy to
https://yourusername.github.io/your-cut-project
.
- ℹ️ Travis will push a
gh-pages
branch to your repo. No touchy. Just leave it be!
- (If your page doesn't auto-deploy, you might have to manually activate Github Pages in your repo settings.)
- Select the
- Canonical reference RE: storing a personal access token on Travis here.
- Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.