Skip to content

Commit 26d800b

Browse files
committed
Suggest using uv in template README
1 parent 2e1d631 commit 26d800b

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

tests/data/test_package_generation/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ Centre for Advanced Research Computing, University College London
5757

5858
We recommend installing in a project specific virtual environment created using
5959
a environment management tool such as
60-
[Conda](https://docs.conda.io/projects/conda/en/stable/). To install the latest
61-
development version of `cookiecutter-test` using `pip` in the currently active
60+
[uv](https://docs.astral.sh/uv/). To install the latest
61+
development version of `cookiecutter-test` using `uv pip` in the currently active
6262
environment run
6363

6464
```sh
65-
pip install git+https://github.com/test-user/cookiecutter-test.git
65+
uv pip install git+https://github.com/test-user/cookiecutter-test.git
6666
```
6767

6868
Alternatively create a local clone of the repository with
@@ -74,7 +74,7 @@ git clone https://github.com/test-user/cookiecutter-test.git
7474
and then install in editable mode by running
7575

7676
```sh
77-
pip install -e .
77+
uv pip install -e .
7878
```
7979

8080
### Running Locally
@@ -112,7 +112,7 @@ from the root of the repository. The built documentation will be written to
112112
`site`.
113113

114114
Alternatively to build and preview the documentation locally, in a Python
115-
environment with the optional `docs` dependencies installed, run
115+
environment with the `docs` dependency group installed, run
116116

117117
```sh
118118
mkdocs serve

{{cookiecutter.project_slug}}/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ Centre for Advanced Research Computing, University College London
6363

6464
We recommend installing in a project specific virtual environment created using
6565
a environment management tool such as
66-
[Conda](https://docs.conda.io/projects/conda/en/stable/). To install the latest
67-
development version of `{{cookiecutter.project_slug}}` using `pip` in the currently active
66+
[uv](https://docs.astral.sh/uv/). To install the latest
67+
development version of `{{cookiecutter.project_slug}}` using `uv pip` in the currently active
6868
environment run
6969

7070
```sh
71-
pip install git+{{cookiecutter.__repo_url}}.git
71+
uv pip install git+{{cookiecutter.__repo_url}}.git
7272
```
7373

7474
Alternatively create a local clone of the repository with
@@ -80,7 +80,7 @@ git clone {{cookiecutter.__repo_url}}.git
8080
and then install in editable mode by running
8181

8282
```sh
83-
pip install -e .
83+
uv pip install -e .
8484
```
8585

8686
### Running Locally
@@ -118,7 +118,7 @@ from the root of the repository. The built documentation will be written to
118118
`site`.
119119

120120
Alternatively to build and preview the documentation locally, in a Python
121-
environment with the optional `docs` dependencies installed, run
121+
environment with the `docs` dependency group installed, run
122122

123123
```sh
124124
mkdocs serve

0 commit comments

Comments
 (0)