From f0b0d7525dc0a353a3422d69dac7ac8575424829 Mon Sep 17 00:00:00 2001 From: Chris--- Date: Mon, 7 Oct 2013 00:14:48 +0100 Subject: [PATCH] add readme --- Readme.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..a2d61ff --- /dev/null +++ b/Readme.md @@ -0,0 +1,64 @@ +Keymap Redefiner +================ + +A simple plugin for remap any keymap within Sublime 2/3 sublime-keymap files; you can just define a new keymap and the plugin will do the rest for you. The plugin also keeps the entry up to date if the context of the keymap changes. + +Usage +----- + +**Keymap Redefiner: Define Keymap:** Define a new key combination for a selected keymap, see demo below. + +**Keymap Redefiner: Update Keymaps:** Update all set keymaps, this command will check all plugins for the selected item and update the context, args values if necessary. + +**Keymap Redefiner: Remove Keymap** Remove a key combination if you which to return to the default one. + +![](https://raw.github.com/wiki/Chris---/SublimeText-Keymap-Redefiner/redefine.gif) + +Installation +------------ + +### Using Package Control: + +* Bring up the Command Palette (Command+Shift+P on OS X, Control+Shift+P on Linux/Windows). +* Select Package Control: Install Package. +* Select Keymap Redefiner to install. + +### Not using Package Control: + +* Save files to the `Packages/Keymap Redefiner` directory, then relaunch Sublime: + * Linux: `~/.config/sublime-text-2|3/Packages/Keymap Redefiner` + * Mac: `~/Library/Application Support/Sublime Text 2|3/Packages/Keymap Redefiner` + * Windows: `%APPDATA%/Sublime Text 2|3/Packages/Keymap Redefiner` + +## Donating + +Support this project via [gittip][] or [paypal][]. + +[![Support via Gittip](https://rawgithub.com/chris---/Donation-Badges/master/gittip.jpeg)][gittip] [![Support via PayPal](https://rawgithub.com/chris---/Donation-Badges/master/paypal.jpeg)][paypal] + +[gittip]: https://www.gittip.com/Chris--- +[paypal]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZWZCJPFSZNXEW + +## License + +All files in this package is licensed under the MIT license. + +Copyright (c) 2013 Chris + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file