From f944f6b8abbde1bb9e4b38569652324a47a68458 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Mon, 14 Sep 2015 05:49:56 -0400 Subject: Add documentation Create a help file with information about the plugin, its primary use case, and information about its mappings (although one of them isn't really noticeable as a customised mapping). Also generate helptags. --- doc/grappele.txt | 31 +++++++++++++++++++++++++++++++ doc/tags | 6 ++++++ 2 files changed, 37 insertions(+) create mode 100644 doc/grappele.txt create mode 100644 doc/tags (limited to 'doc') diff --git a/doc/grappele.txt b/doc/grappele.txt new file mode 100644 index 0000000..459741f --- /dev/null +++ b/doc/grappele.txt @@ -0,0 +1,31 @@ +*grappele.txt* Recall the last G movement + +Author: Teddy Wing +License: MIT +Version: 0.0.1 + +============================================================================== +INTRODUCTION *grappele-introduction* + +Grappele saves your last |G| movement and provides a way to easily repeat it. +I often find myself typing `278G` for example only to realise that I'm in the +wrong window. I'll then have to switch to the window I was originally looking +at and type `278G` again. With Grappele, I can use |G| normally and if I mess +up, the last |G| command can be quickly repeated with a mapping. + +============================================================================== +MAPPINGS *grappele-mappings* + + *grappele-G* +G Same as Vim's standard |G|. Stores the count of its + most recent use. + + *gG* +gG Go to the line specified by the most recent use of |G| + +============================================================================== +LICENSE *grappele-license* + +Grappele is released under the MIT license. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..a82f451 --- /dev/null +++ b/doc/tags @@ -0,0 +1,6 @@ +gG grappele.txt /*gG* +grappele-G grappele.txt /*grappele-G* +grappele-introduction grappele.txt /*grappele-introduction* +grappele-license grappele.txt /*grappele-license* +grappele-mappings grappele.txt /*grappele-mappings* +grappele.txt grappele.txt /*grappele.txt* -- cgit v1.2.3