Skip to content

Commit 93bb821

Browse files
author
a.pirogov
committed
update readme to include suggestion in #8, closes #8
1 parent 5ee056e commit 93bb821

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,33 @@ recommendations on the state of software citation in academic practice.
6969

7070
## Getting Started
7171

72-
First, make sure that you have a recent version of cookiecutter (`cookiecutter>=2.1`).
72+
First, make sure that you have a recent version of
73+
[cookiecutter](https://www.cookiecutter.io/) (`cookiecutter>=2.1`).
7374
This template does not work with older versions, because they lack some needed features.
7475

7576
To install `cookiecutter`, you can run `pip install cookiecutter`.
7677

7778
To generate a new Python project from this template, run:
7879

79-
```
80+
```bash
8081
cookiecutter https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter
8182
```
8283

84+
This will spawn an interactive prompt, where you have to provide some information and select
85+
a starting skeleton for your software project. Don't worry, you can always adapt this
86+
information later on by hand. After this cookiecutter will initate your software project.
87+
88+
The generated repository will include a copy of a [developer guide](./dev_guide.md),
89+
containing more information about the structure and features of the generated project.
90+
Feel free to either remove it, or keep (and possibly adjust) it as extended technical
91+
project documentation for yourself and other future project contributors.
92+
93+
## Configuring the Template
94+
8395
If you intend to use the template a lot, e.g. if you want to use (an adaptation of)
8496
this template as the default way to start a Python project for yourself and/or others,
85-
you might want to configure some template variables in your `~/.cookiecutterrc`, e.g.:
97+
you might want to configure some template variables in your `~/.cookiecutterrc`.
98+
Here is an example cookiecutter configuration:
8699

87100
```yaml
88101
default_context:
@@ -96,14 +109,9 @@ default_context:
96109
author_orcid: "0000-0000-1234-5678"
97110
```
98111
99-
This information will then be already pre-filled when you use the template,
112+
This information will be already pre-filled when you use the template,
100113
saving you some time and possibly avoiding possible mistakes from manual typing.
101114
102-
The generated repository will include a copy of a [developer guide](./dev_guide.md),
103-
containing more information about the structure and features of the generated project.
104-
Feel free to either remove it, or keep (and possibly adjust) it as extended technical
105-
project documentation for yourself and other future project contributors.
106-
107115
<!-- --8<-- [end:quickstart] -->
108116
109117
<!-- --8<-- [start:citation] -->

0 commit comments

Comments
 (0)