From 60db54c6537aa03f0070d75628bdbf65942a2598 Mon Sep 17 00:00:00 2001 From: Sv443 Date: Wed, 20 Nov 2024 21:43:32 +0100 Subject: [PATCH] docs: install dev & plugin template setup sections --- README-summary.md | 3 ++- README.md | 3 ++- contributing.md | 1 + 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README-summary.md b/README-summary.md index 965cfaa21..8a7d5226e 100644 --- a/README-summary.md +++ b/README-summary.md @@ -64,7 +64,8 @@ Note: the `unsafeWindow` grant is required due to limitations in some browsers,
-To install the latest development build [click here](https://github.com/Sv443/BetterYTM/raw/develop/dist/BetterYTM.user.js) (make sure to fully reinstall the userscript once the next release is out) +If you want to install the latest (potentially unstable) development build, [look for the latest pull request](https://github.com/Sv443/BetterYTM/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen) and click the install button there. +Please make sure to fully reinstall the userscript once the next release is out to avoid any issues. diff --git a/README.md b/README.md index a78e02fb2..53861ba89 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,8 @@ Note: the `unsafeWindow` grant is required due to limitations in some browsers, -To install the latest development build [click here](https://github.com/Sv443/BetterYTM/raw/develop/dist/BetterYTM.user.js) (make sure to fully reinstall the userscript once the next release is out) +If you want to install the latest (potentially unstable) development build, [look for the latest pull request](https://github.com/Sv443/BetterYTM/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen) and click the install button there. +Please make sure to fully reinstall the userscript once the next release is out to avoid any issues. diff --git a/contributing.md b/contributing.md index 8c951660b..112bd7498 100644 --- a/contributing.md +++ b/contributing.md @@ -240,6 +240,7 @@ If you need help with these, don't hesitate to reach out to me (see the top of t GreasyFork also needs the relevant section of the changelog, but the internal and plugin changes should be trimmed out 9. Send an announcement in the Discord server linking to the install pages and the changelog, with a summary of the most important changes 10. Update the [BYTM plugin template](https://github.com/Sv443/BetterYTM-Plugin-Template) by setting the BYTM submodule to the *exact* commit matching the release and making sure everything else is compatible with the changes of the latest BYTM version + 11. Create a release in the BYTM plugin template repository with the same tag as the BYTM release, following the format of the previous releases