diff options
| author | Teddy Wing | 2017-04-29 07:51:48 +0200 |
|---|---|---|
| committer | Teddy Wing | 2017-04-29 07:51:48 +0200 |
| commit | 19b78a861e9b025b652f6415a8feae33cadfe036 (patch) | |
| tree | 45f7c57be310338821178a562e33f53a8a262365 | |
| parent | 58eb3fe8a2a26ad6a6bdfba7781cc69fc777b3f8 (diff) | |
| download | vim-gitcha-19b78a861e9b025b652f6415a8feae33cadfe036.tar.bz2 | |
Add Vim documentation
Include a short description, information about the included completion
mapping, and license text.
| -rw-r--r-- | doc/gitcha.txt | 41 | ||||
| -rw-r--r-- | doc/tags | 5 |
2 files changed, 46 insertions, 0 deletions
diff --git a/doc/gitcha.txt b/doc/gitcha.txt new file mode 100644 index 0000000..d166119 --- /dev/null +++ b/doc/gitcha.txt @@ -0,0 +1,41 @@ +*gitcha.txt* Completion for Git SHAs in commit messages + +Author: Teddy Wing <http://teddywing.com> +License: GPLv3+ +Version: 0.0.1 + +============================================================================== +INTRODUCTION *gitcha* + +A custom completion function that enables Git commit SHAs to be completed when +writing commit messages. + +============================================================================== +MAPPINGS *gitcha-mappings* + + *gitcha-<Plug>GitchaCompleteSHA* +<Plug>GitchaCompleteSHA + Complete the Git commit SHA under the cursor. + + Default: <C-x><C-s> + + +============================================================================== +LICENSE *gitcha-license* + +Copyright (c) 2017 Teddy Wing + +Vim-gitcha is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +Vim-gitcha is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with Vim-gitcha If not, see <http://www.gnu.org/licenses/>. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..3118b77 --- /dev/null +++ b/doc/tags @@ -0,0 +1,5 @@ +gitcha gitcha.txt /*gitcha* +gitcha-<Plug>GitchaCompleteSHA gitcha.txt /*gitcha-<Plug>GitchaCompleteSHA* +gitcha-license gitcha.txt /*gitcha-license* +gitcha-mappings gitcha.txt /*gitcha-mappings* +gitcha.txt gitcha.txt /*gitcha.txt* |