Skip to content

Commit 227f82b

Browse files
committed
rename options/cases to scenarios
1 parent 5aa33de commit 227f82b

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,19 @@ Use this [Copier](https://copier.readthedocs.io) template to generate an empty P
4444

4545
There are multiple scenarios to use this template:
4646

47-
1. Generating a new package using template
48-
2. Applying the template to some pre-existing code
49-
3. Updating a package made with the template
47+
[Scenario 1](#scenario-1-create-a-new-package): Generating a new package using template
48+
[Scenario 2](#scenario-2-apply-to-pre-existing-code): Applying the template to some pre-existing code
49+
[Scenario 3](#scenario-3-updating-a-template-made-package): Updating a package made with the template
5050

51-
In all three cases, you will need to install copier first:
51+
In all three scenarios, you will need to install copier first:
5252
```shell
5353
pipx install copier
5454
```
5555

56-
### Option 1: Create a new package
56+
### Scenario 1: Create a new package
5757

5858

59-
#### Step 1/2: Generate the files and directory structure
59+
#### Step 1/2: Create the files and directory structure
6060

6161
Run `copier` with the template:
6262

@@ -83,7 +83,7 @@ copier copy https://github.com/nlesc/python-template.git path/to/destination
8383
| code_of_conduct_email | yourname@esciencecenter.nl | Email address of the person who should be contacted in case of violations of the Code of Conduct. |
8484

8585
Once the project files have been generated, follow the steps outlined in
86-
[template/next_steps.md](template/next_steps.md).
86+
[next_steps.md](template/next_steps.md).
8787

8888
#### Step 2/2: Read about what was just generated
8989

@@ -145,7 +145,7 @@ Good job! You have now generated the skeleton for your package:
145145

146146
For an explanation of what's there, read on in the [project_setup.md](template/project_setup.md) file.
147147

148-
### Option 2: Apply to pre-existing code
148+
### Scenario 2: Apply to pre-existing code
149149

150150
To apply the template to pre-existing code, you can use the same `copier copy`
151151
command as when creating a new package, except that you point to the folder
@@ -162,7 +162,7 @@ conflicts. Especially if your files are already under version control, it is
162162
recommended to answer 'yes' for all files, you will still be able to review
163163
the changes suggested by the template.
164164

165-
### Option 3. Updating a template-made package
165+
### Scenario 3. Updating a template-made package
166166

167167
Copier provides the functionality for re-applying the template to a previously
168168
created project using the `copier update` command. This has two effects:

0 commit comments

Comments
 (0)