Merge pull request #623 from NLeSC/575-user-profiles

575-user-profiles

Author: lyashevska

CHANGELOG.md

@@ -17,6 +17,7 @@
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
 
 ### Changed
+* Update the user documentation (README.md) of the template [#575](https://github.com/NLeSC/python-template/pull/623)
 * Updated .gitignore [#622](https://github.com/NLeSC/python-template/pull/622)
 * add extra info for sub-menus [#628](https://github.com/NLeSC/python-template/pull/628)
 * skip merging CHANGELOG.md and CODE_OF_CONDUCT.md if they exist [#628](https://github.com/NLeSC/python-template/pull/628)

README.md

@@ -1,8 +1,26 @@
 # Netherlands eScience Center Python Template
 
-Spend less time setting up and configuring your new Python packages which includes research software good practices from the start.
+Spend less time setting up and configuring your new Python packages by using this template. This [Copier](https://copier.readthedocs.io) template includes best practices for research software so your new package will include these practices from the start. 
 
-Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
+You can choose from various user profiles, each offering a range of features to suit your needs.
+
+## User profiles
+
+The template profiles for a Python package offer varying levels of customization to cater to different user needs. Below are the profiles the template offers.
+
+### Minimum
+
+This profile offers the essential features to begin developing a Python package, making it ideal for first-time research software developers. Additional features can be added as needed.
+
+### Recommended
+
+This option provides a pre-selected set of features for research software, which users can fully customize.
+
+### Let me choose
+
+This fully customizable profile enables you to selectively include or exclude features in your Python package.
+
+## Features
 
 - Boilerplate unit tests and documentation,
 - [Python static setup configuration](template/pyproject.toml.jinja),
@@ -14,7 +32,7 @@ Use this [Copier](https://copier.readthedocs.io) template to generate an empty P
   - [README.md](template/README.md.jinja) for package users,
   - [README.dev.md](template/README.dev.md.jinja) for package developer,
   - [project_setup.md](template/project_setup.md.jinja) with extensive documentation about project setup,
-  - [Change log](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
+  - [Changelog](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
   - [Code of Conduct](template/CODE_OF_CONDUCT.md.jinja),
   - [Contributing guidelines](template/CONTRIBUTING.md.jinja),
 - Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),