From a3ee4d1c00f8ad038b50e1a1dc7a05865887ee66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Bodn=C3=A1r?= Date: Sat, 21 May 2022 16:37:46 +0200 Subject: [PATCH] docs: add link to video tutorials on YouTube Plus some minor readme improvements. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index edc924a..2a14b0a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# About +# Greasemonkey (User) Scripts -This project contains various handy user scripts for the [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) (only for Firefox; GM) and [Tampermonkey](https://www.tampermonkey.net/) (for Chrome, but also for other browsers; TM) browser addons. A user script is a piece of JavaScript code which gets executed on page load and which extends functionality of the pages it was written for. +This project contains various handy user scripts for the [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) (only for Firefox; GM) and [Tampermonkey](https://www.tampermonkey.net/) (for Chrome, but also for other browsers; TM) browser addons. A [user script](https://en.wikipedia.org/wiki/Userscript) is a piece of JavaScript code which gets executed on page load and which extends functionality of the pages it was written for. -# Installation +## YouTube Tutorials + +Videos in the following YouTube playlist might help you to get started with this project quickly: [gm-scripts - User scripts for Jira](https://www.youtube.com/playlist?list=PLRRrWIs5dbQ0jsdhgz_gRe-RH4ybNfwni). + +## Installation Firstly install the aforementioned addon for your favorite browser and then simply open the selected *\*.user.js* file in the browser. GM (or TM) will guide you through the rest of the user script installation. The most important thing to do is to set up the pages for which you want to have the given user script activated. You can always find an example of the appropriate "include pattern" right in the installed user script. @@ -10,7 +14,7 @@ An example configuration: ![screenshot](screenshots/JIRA_copy_GM-options.png) -# Usage +## Usage The usage is always specific to a given user script. Most user scripts should offer a special help dialog that can be opened via the GM / TM toolbar icon. And of course, you can always look into the script's source code and see what it actually does... :) @@ -26,17 +30,17 @@ One of the JIRA_shotcuts user script functions in action: ![screenshot](screenshots/JIRA_shortcuts_fn-alter-estim.png) -# Troubleshooting +## Troubleshooting What if something is not working as expected? Then you should firstly try to find some relevant information or error messages in the console log - this is typically available by pressing F12 in your browser and by navigating to the "Console" tab. And select for example "Logging -> Log" to see detailed logging from the GM scripts in Firefox. If you find a bug or a missing feature, you can create a new issue for that on the "Issues" page of this Github project. -# For developers +## For Developers This special chapter includes tips for those who would like to develop GM / TM scripts. -## Run GM Scripts on Local Disk Files +### Run GM Scripts on Local Disk Files Set the following on the "about:config" page in Firefox: @@ -44,7 +48,7 @@ Set the following on the "about:config" page in Firefox: See http://stackoverflow.com/questions/9931115/run-greasemonkey-on-html-files-located-on-the-local-filesystem -## Force GM to Run Script in Sandbox +### Force GM to Run Script in Sandbox At least some `@grant <> 'none'` must be present in the user script's header in order to force GM to run the script 'in sandbox'.