Skip to content

Commit f8c96c6

Browse files
authored
Simplify install instructions (#555)
My 'hot' take is that the goal of the install instructions should be a single direct recommended way to use the template, with minimal diversions. Here I've changed the alternative install instructions to still link to the `cookiecutter` install instructions, but to shorten it to reduce potential diversion from the recommended way.
1 parent 62715e2 commit f8c96c6

File tree

1 file changed

+2
-9
lines changed

1 file changed

+2
-9
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,13 @@ Python packages with our recommended tooling set up and ready to go.
2525
Some quick instructions for using our template are below.
2626
We also have a longer [tutorial](./tutorial.md) that has been presented in workshops for researchers at UCL.
2727

28-
If you have [uv] installed, you can use our template with the following one-liner:
28+
If you have [uv] installed, you can use our template with the following command:
2929

3030
```sh
3131
uvx cookiecutter gh:ucl-arc/python-tooling --checkout latest
3232
```
3333

34-
Alternatively you can [install cookiecutter] (following the recommended instructions).
35-
Do this if you don't use [uv], or if you're likely to want to use cookiecutter again.
36-
37-
Then you'll need to run cookiecutter with our template:
38-
39-
```sh
40-
cookiecutter gh:ucl-arc/python-tooling --checkout latest
41-
```
34+
If you don't want to use uv you can [install cookiecutter] using pip, and run the above command without the leading `uvx`.
4235

4336
When [cookiecutter] runs, it will ask you a series of questions to configure your project.
4437
Type the answer or hit return without typing anything to use the default option (shown in parenthesis).

0 commit comments

Comments
 (0)