Skip to content

Commit

Permalink
Fix README links (#321)
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep authored Sep 25, 2024
1 parent 2d92598 commit 5ffa808
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,27 @@
# {{ cookiecutter.project_name }}

[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]
[![Tests][badge-tests]][tests]
[![Documentation][badge-docs]][documentation]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name }}/test.yaml?branch=main
[link-tests]: https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.github_repo }}/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/{{ cookiecutter.project_name }}

{{ cookiecutter.project_description }}

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

- [API documentation][link-api].
Please refer to the [documentation][],
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](https://github.com/conda-forge/miniforge#mambaforge).
You need to have Python 3.10 or newer installed on your system.
If you don't have Python installed, we recommend installing [Mambaforge][].

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

<!--
1) Install the latest release of `{{ cookiecutter.project_name }}` from [PyPI][link-pypi]:
1) Install the latest release of `{{ cookiecutter.project_name }}` from [PyPI][]:
```bash
pip install {{ cookiecutter.project_name }}
Expand All @@ -38,20 +36,22 @@ pip install git+https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutte

## Release notes

See the [changelog][changelog].
See the [changelog][].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
If you found a bug, please use the [issue tracker][issue-tracker].
For questions and help requests, you can reach out in the [scverse discourse][].
If you found a bug, please use the [issue tracker][].

## Citation

> t.b.a
[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name }}/issues
[changelog]: https://{{ cookiecutter.project_name }}.readthedocs.io/latest/changelog.html
[link-docs]: https://{{ cookiecutter.project_name }}.readthedocs.io
[link-api]: https://{{ cookiecutter.project_name }}.readthedocs.io/latest/api.html
[link-pypi]: https://pypi.org/project/{{ cookiecutter.project_name }}
[mambaforge]: https://github.com/conda-forge/miniforge#mambaforge
[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
[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
[pypi]: https://pypi.org/project/{{ cookiecutter.project_name }}

0 comments on commit 5ffa808

Please sign in to comment.