Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 5 additions & 0 deletions copier/questions/features.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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?
2 changes: 2 additions & 0 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down