Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 2.17 KB

README.adoc

File metadata and controls

39 lines (27 loc) · 2.17 KB
Raw

Feel++ Template Project

DOI GitHub Release CI

This repository provides a basic starting point for a Feel++ application including:

  • ✓ Feel++ applications in C++ to use Feel++ and Feel++ toolboxes in src

  • ✓ documentation using asciidoc and antora

  • ✓ python Feel++ notebooks that can be downloaded from the documentation

  • ✓ continuous integration including tests for the C++ applications

  • ✓ docker image generation for the project

The documentation for feelpp-project is available at here and you can build on it for your project by enabling the github pages for your repository.

Renaming the project

By default the project is named feelpp-project if you cloned the repository feelpp/feelpp-project. However if you used the previous repository as a template, then the project is renamed using the name of the repository using the script rename.sh at the initialization of the repository. If the name does not suit you, you can change it again using the script rename.sh and providing the new name as argument.

Warning
 the script rename.sh will rename the project however some url might be set properly if you rename the project yourself. You need to check the following files: docs/site.yml and docs/package.json and fix the urls after the rename process is done.

Updating the feelpp-project version

The version of the project is defined in the files CMakeLists.txt, docs/antora.yml and docs/package.json. You need to update with the same version in all files.

Release process

  • ✓ update the version in CMakeLists.txt

  • ✓ update the version in docs/antora.yml

  • ✓ commit the changes with the message "Release vx.y.z". At this point the CI will generate the docker image and push it to docker hub