Skip to content

Simplify install instructions #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samcunliffe merged 2 commits into from
Jul 15, 2025
Merged

Simplify install instructions #555

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27770ac
Simplify install instructions
dstansby Jul 15, 2025
afa29d6
Put back link
dstansby Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,13 @@ We also have a [tutorial](./tutorial.md) that has been presented in a couple of

## Using our template

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

```sh
uvx cookiecutter gh:ucl-arc/python-tooling --checkout latest
```

Alternatively you can [install cookiecutter] (following the recommended instructions).
Do this if you don't use [uv], or if you're likely to want to use cookiecutter again.

Then you'll need to run cookiecutter with our template:

```sh
cookiecutter gh:ucl-arc/python-tooling --checkout latest
```
If you don't want to use uv you can [install cookiecutter] using pip, and run the above command without the leading `uvx`.

When [cookiecutter] runs, it will ask you a series of questions to configure your project.
Type the answer or hit return without typing anything to use the default option (shown in parenthesis).
Expand Down Expand Up @@ -73,7 +66,6 @@ uv pip install -e ".[dev]"
[website]: https://github-pages.arc.ucl.ac.uk/python-tooling
[UCL ARC]: https://ucl.ac.uk/arc
[cookiecutter]: https://cookiecutter.readthedocs.io/en/stable
[install cookiecutter]: https://cookiecutter.readthedocs.io/en/stable/README.html#installation
Copy link
Copy Markdown
Member

@samcunliffe samcunliffe Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We either need this. Or remove the link in the text body ☝️ .

I'd maybe keep this as is but delete the using pip, (since I have no preference how you install cookiecutter but probably cookiecutter's docs do.

Copy link
Copy Markdown
Member Author

@dstansby dstansby Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, this was pre-commit being funny, definitely not intended

[uv]: https://docs.astral.sh/uv
<!-- prettier-ignore-end -->

Expand Down
Loading