From d8d896a7a193609d9a90b5a5a244b91ded8d66c4 Mon Sep 17 00:00:00 2001 From: Alex Voss Date: Wed, 25 Oct 2023 11:31:48 +0100 Subject: [PATCH] +link to fork for PRs, fixed link broken in website version --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eaf23c3f..f2f40c8a 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,9 @@ Following initiative from the author of Material for MkDocs, this plugin provide ## Development -Clone the repository: +Clone the repository. If you are not a collaborator then first [fork it +on GitHub](https://github.com/Guts/mkdocs-rss-plugin/fork) and clone +your fork. Change into the directory that contains the code, then: ```bash # install development dependencies @@ -86,7 +88,7 @@ python -m pip install -U -r requirements/documentation.txt # alternatively: pip install -e .[doc] ``` -Then follow the [contribution guidelines](CONTRIBUTING.md). +Then follow the [contribution guidelines](https://github.com/Guts/mkdocs-rss-plugin/blob/main/CONTRIBUTING.md) ## Release workflow