Skip to content
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

Update / fix README template #356

Merged
merged 4 commits into from
Mar 7, 2025
Merged

Update / fix README template #356

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f15e44f
fix test workflow badge link
le-ander Mar 5, 2025
8830ccf
flying-sheep Mar 5, 2025
7b4ebfe
replace mambaforge with miniforge
le-ander Mar 5, 2025
8895e97
recommend uv for python installs
le-ander Mar 5, 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
6 changes: 3 additions & 3 deletions {{cookiecutter.project_name}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ in particular, the [API documentation][].
## Installation

You need to have Python 3.10 or newer installed on your system.
If you don't have Python installed, we recommend installing [Mambaforge][].
If you don't have Python installed, we recommend installing [uv][].

There are several alternative options to install {{ cookiecutter.project_name }}:

Expand Down Expand Up @@ -47,10 +47,10 @@ If you found a bug, please use the [issue tracker][].

> t.b.a

[mambaforge]: https://github.com/conda-forge/miniforge#mambaforge
[uv]: https://github.com/astral-sh/uv
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name }}/issues
[tests]: https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.github_repo }}/actions/workflows/test.yml
[tests]: https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.github_repo }}/actions/workflows/test.yaml
[documentation]: https://{{ cookiecutter.project_name }}.readthedocs.io
[changelog]: https://{{ cookiecutter.project_name }}.readthedocs.io/en/latest/changelog.html
[api documentation]: https://{{ cookiecutter.project_name }}.readthedocs.io/en/latest/api.html
Expand Down
Loading