diff --git a/CHANGELOG.md b/CHANGELOG.md index 24e904ba..bf47702e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [Unreleased] ### Added +* Make project setup guidelines optional [553](https://github.com/NLeSC/python-template/pull/553) * Make contributing guidelines optional [#465]() * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541) * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530) diff --git a/copier/questions/features.yml b/copier/questions/features.yml index c5c6e185..f193e72d 100644 --- a/copier/questions/features.yml +++ b/copier/questions/features.yml @@ -60,3 +60,8 @@ AddDevDoc: type: bool default: "{{ template_profile != 'minimum' }}" help: Add developer documentation? +AddProjectSetup: + when: "{{ template_profile == 'ask' }}" + type: bool + default: "{{ template_profile != 'minimum' }}" + help: Add a document to describe project setup? diff --git a/template/README.md.jinja b/template/README.md.jinja index 8523375a..d165c82c 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -30,11 +30,13 @@ | Link checker | [![link-check]({{repository_url}}/actions/workflows/link-check.yml/badge.svg)]({{repository_url}}/actions/workflows/link-check.yml) | {%- endif -%} +{% if AddProjectSetup -%} ## How to use {{ package_name }} {{ package_short_description|replace('\"', '\\\"') }} The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it. +{%- endif %} ## Installation diff --git a/template/project_setup.md.jinja b/template/{% if AddProjectSetup %}project_setup.md{% endif %}.jinja similarity index 100% rename from template/project_setup.md.jinja rename to template/{% if AddProjectSetup %}project_setup.md{% endif %}.jinja