Skip to content
Merged
Changes from all commits
Commits
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
27 changes: 19 additions & 8 deletions {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,31 @@ in particular, the [API documentation][].
You need to have Python 3.12 or newer installed on your system.
If you don't have Python installed, we recommend installing [uv][].

There are several alternative options to install {{ cookiecutter.project_name }}:
We recommend managing dependencies in project-specific virtual environments to avoid dependency conflicts.
This is most convenient using package managers such as [uv][].
Choose from the options below to install {{ cookiecutter.project_name }}:

<!--
1) Install the latest release of `{{ cookiecutter.project_name }}` from [PyPI][]:
1. Add the latest release of `{{ cookiecutter.project_name }}` from [PyPI][] to your `uv` project:

```bash
uv add {{ cookiecutter.project_name }}
```

1. Install the latest release into a [standard virtual environment][venv]:

```bash
(after activating your venv)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder whether this isn't clear to "newbies"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

agree, always hard to judge how verbose to be.
If they'd click the [venv] link above, they'd learn what to do.

pip install {{ cookiecutter.project_name }}
```

```bash
pip install {{ cookiecutter.project_name }}
```
-->

1. Install the latest development version:

```bash
pip install git+https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.github_repo }}.git@main
```
```bash
pip install git+https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.github_repo }}.git # (or `uv add`)
```

## Release notes

Expand All @@ -55,3 +65,4 @@ If you found a bug, please use the [issue tracker][].
[changelog]: https://{{ cookiecutter.project_name }}.readthedocs.io/page/changelog.html
[api documentation]: https://{{ cookiecutter.project_name }}.readthedocs.io/page/api.html
[pypi]: https://pypi.org/project/{{ cookiecutter.project_name }}
[venv]: https://docs.python.org/3/tutorial/venv.html
Loading