diff --git a/README.md b/README.md index 4ca5706d6538a159d9333c68b054baae61542c01..aa949d3c712f8a9369c6e6fa6dbde4f0ff4bd485 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Example Python Package +# CPP Project CookieCutter Template - - + + An example repository of an CI/CD pipeline for building, testing and publishing a python package. @@ -18,7 +18,7 @@ pip install --user cookiecutter Then you can create an instance of your template with: ```bash -cookiecutter https://git.astron.nl/templates/python-package.git +cookiecutter https://git.astron.nl/templates/cpp-project.git # Next follow a set of prompts (such as the name and description of the package) ``` diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 57e36c53e6b4edea5add465a7adb914e31b97b41..0aa801286c7d7d0c7146a4f626b1a41e2c00eeca 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -22,8 +22,7 @@ project needs to be changed to use `make`. ## Getting started -- Clone the project in the directory `$repo` -- Install all dependencies as listed in `ci/ubuntu_22_04-base` +- Install all dependencies as listed in `docker/ci-runnner/Dockerfile` - Create build directory: `mkdir build` - Create the project: `cmake -DBUILD_TESTING=ON -DBUILD_DOCUMENTATION=ON -B ./build -G Ninja` - Build the project: `ninja -C ./build`