Skip to content

Commit caeef1b

Browse files
committed
first version for readme
1 parent d21c1d5 commit caeef1b

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# Netherlands eScience Center Python Template
22

3-
Spend less time setting up and configuring your new Python packages which includes research software good practices from the start.
3+
Are you writing research software? Save your time on setting up and configuring your new Python packages by using this template. This [Copier-based](https://copier.readthedocs.io) template includes best practices for research software from the beginning. You can choose from various user profiles, each offering a range of features to suit your needs.
44

5-
Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
5+
## User profiles
6+
- **Minimum**
7+
As the name says is the bare minimum to get started with a Python package.
8+
- **Recommended**
9+
This profile is based on the Minimum and includes set of carefully selected features which we believe the users might want. However, all features can be modified by the user.
10+
- **Let me choose**
11+
This is a fully customizable profile. You can choose from a list of features to include in your package as you like.
12+
13+
## Features
614

715
- Boilerplate unit tests and documentation,
816
- [Python static setup configuration](template/pyproject.toml.jinja),
@@ -14,7 +22,7 @@ Use this [Copier](https://copier.readthedocs.io) template to generate an empty P
1422
- [README.md](template/README.md.jinja) for package users,
1523
- [README.dev.md](template/README.dev.md.jinja) for package developer,
1624
- [project_setup.md](template/project_setup.md.jinja) with extensive documentation about project setup,
17-
- [Change log](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
25+
- [Changelog](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
1826
- [Code of Conduct](template/CODE_OF_CONDUCT.md.jinja),
1927
- [Contributing guidelines](template/CONTRIBUTING.md.jinja),
2028
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),

0 commit comments

Comments
 (0)