Skip to content

Commit 67496fd

Browse files
author
Janneke van der Zwaan
committed
Make table for explaining the requested information
1 parent 893b991 commit 67496fd

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Netherlands eScience Center Python Template
22
===========================================
33

4-
Spend less time setting up and configuring your new Python projects and comply with the
4+
Spend less time setting up and configuring your new Python packages and comply with the
55
[Netherlands eScience Center Software Development Guide](https://guide.esciencecenter.nl/)
66
from the start.
77

@@ -45,17 +45,19 @@ cookiecutter https://github.com/nlesc/python-template.git
4545

4646
You will be asked to supply the following information about your project:
4747

48-
* *full_name []:* Please fill in your full name. e.g. 'John Smith'
49-
* *email [[email protected]]:* Your work email address
50-
* *code_of_conduct_email [[email protected]]:* Email address of the person who should be contacted in case of violations of the Code of Conduct (could be the PI)
51-
* *copyright_holder:* Name(s) of the organization(s) or person(s) who hold the copyright of the software (e.g., Netherlands eScience Center)
52-
* *github_organization []:* Please enter the GitHub organization that will contain this project's repository. This can also be your github user name.
53-
* *project_name [Python Boilerplate]:* Please write the name of your project out in full.
54-
* *project_slug []:* This will be the name of the directory to be created and the git repository.
55-
* *project_short_description []:* The information that you enter here will end up in the README.md, the License and the setup.py files, so it may be a good idea to have a short description of the project ready.
56-
* *version [0.1.0]:* The first version for your project, NLeSC preference is using semantic versioning
57-
* *Select open_source_license:* The intended license, NLeSC preference is Apache 2.0
58-
* *apidoc:* Add support for automatically generating a module index from the `docstrings` in your Python package (look at the [scriptcwl package](http://scriptcwl.readthedocs.io/en/latest/apidocs/scriptcwl.html) for an example); the default is no apidocs
48+
| Name | Default value | Explanation |
49+
| ------------------------- | ------------- | ----------- |
50+
| full_name | | Your full name, e.g. 'John Smith'. |
51+
| email | [email protected] | Your (work) email address |
52+
| code_of_conduct_email | [email protected] | Email address of the person who should be contacted in case of violations of the Code of Conduct. |
53+
| copyright_holder | | Name(s) of the organization(s) or person(s) who hold the copyright of the software (e.g., Netherlands eScience Center). |
54+
| github_organization | | GitHub organization that will contain this project's repository. This can also be your github user name. |
55+
| project_name | My Python Project | Full project/package name. |
56+
| project_slug | my_python_project | This will be the name of the directory to be created and the git repository. |
57+
| project_short_description | | The information that you enter here will end up in the README, documentation, license, and setup.py, so it may be a good idea to prepare something in advance. |
58+
| version | 0.1.0 | |
59+
| open_source_license | Apache 2.0 (1) | The software license under which the code is made available. |
60+
| apidoc | no (1) | Add support for automatically generating a module index from the `docstrings` in your Python package (look at the [scriptcwl package](http://scriptcwl.readthedocs.io/en/latest/apidocs/scriptcwl.html) for an example). |
5961

6062
How to contribute
6163
=================

0 commit comments

Comments
 (0)