diff options
| author | Teddy Wing | 2017-09-29 00:49:38 +0200 |
|---|---|---|
| committer | Teddy Wing | 2017-09-29 00:56:15 +0200 |
| commit | de8013b706108713397158ac0bb0ce8ed32015de (patch) | |
| tree | bfc62215628f6b0a9c4e2b80b768db3408dd43c4 | |
| parent | 221c6951a7447b2c588bcb69c150b289efcdefcb (diff) | |
| download | GitHub-Apple-Option-P-to-Preview-de8013b706108713397158ac0bb0ce8ed32015de.tar.bz2 | |
Add READMEv0.0.1
Include a description of the problem and script, installation
instructions, and license information.
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8309321 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +GitHub Apple-Option-P to Preview +================================ + +A [Greasemonkey][1] user script that allows GitHub’s comment Preview pane to be +toggled with the keyboard shortcut `Apple-Option-P`. + +By default, GitHub uses `Apple-Shift-P` for this function. In Firefox, +`Apple-Shift-P` opens a new private browsing window, shadowing GitHub’s +shortcut. + +This script provides a mechanism to easily toggle the Preview pane in Firefox +without having to modify internal application shortcuts. + + +## Install +Ensure Greasemonkey is installed and activated. Open the [raw script][2] and +click “Install” in the resulting dialog. A [more detailed explanation][3] is +available on the Greasemonkey wiki. + + +## License +Copyright © 2017 Teddy Wing. Licensed under the GNU GPLv3+ (see the included +COPYING file). + + +[1]: https://www.greasespot.net/ +[2]: https://raw.githubusercontent.com/teddywing/github-apple-option-p-to-preview/master/github-apple-option-p-to-preview.user.js +[3]: https://wiki.greasespot.net/Greasemonkey_Manual:Installing_Scripts |