From 5ffa808cf032753b1f9e4b3b36ed834149151239 Mon Sep 17 00:00:00 2001 From: "Philipp A." Date: Wed, 25 Sep 2024 15:37:09 +0200 Subject: [PATCH] Fix README links (#321) --- {{cookiecutter.project_name}}/README.md | 36 ++++++++++++------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index d907f1fa..d9942f4f 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -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 }}: