From 99fe2c62624f279dc2250872da003bc43cee386b Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Mon, 17 Oct 2016 18:09:56 -0400
Subject: Add Vim help

Add a help file with a description, example, mappings list, and list of
colours to customise.
---
 doc/tags     |  19 +++++++++++
 doc/todo.txt | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 129 insertions(+)
 create mode 100644 doc/tags
 create mode 100644 doc/todo.txt

diff --git a/doc/tags b/doc/tags
new file mode 100644
index 0000000..c503539
--- /dev/null
+++ b/doc/tags
@@ -0,0 +1,19 @@
+todo	todo.txt	/*todo*
+todo-<Plug>TwodoDescalate	todo.txt	/*todo-<Plug>TwodoDescalate*
+todo-<Plug>TwodoEscalate	todo.txt	/*todo-<Plug>TwodoEscalate*
+todo-<Plug>TwodoMarkComplete	todo.txt	/*todo-<Plug>TwodoMarkComplete*
+todo-<Plug>TwodoMarkDeleted	todo.txt	/*todo-<Plug>TwodoMarkDeleted*
+todo-<Plug>TwodoMarkPartiallyCompleted	todo.txt	/*todo-<Plug>TwodoMarkPartiallyCompleted*
+todo-<Plug>TwodoNewTodoAbove	todo.txt	/*todo-<Plug>TwodoNewTodoAbove*
+todo-<Plug>TwodoNewTodoBelow	todo.txt	/*todo-<Plug>TwodoNewTodoBelow*
+todo-<Plug>TwodoRemoveOldTodos	todo.txt	/*todo-<Plug>TwodoRemoveOldTodos*
+todo-colors	todo.txt	/*todo-colors*
+todo-example	todo.txt	/*todo-example*
+todo-license	todo.txt	/*todo-license*
+todo-mappings	todo.txt	/*todo-mappings*
+todo-todoCompleted	todo.txt	/*todo-todoCompleted*
+todo-todoDeleted	todo.txt	/*todo-todoDeleted*
+todo-todoImportant	todo.txt	/*todo-todoImportant*
+todo-todoUndone	todo.txt	/*todo-todoUndone*
+todo-todoUnimportant	todo.txt	/*todo-todoUnimportant*
+todo.txt	todo.txt	/*todo.txt*
diff --git a/doc/todo.txt b/doc/todo.txt
new file mode 100644
index 0000000..22606c4
--- /dev/null
+++ b/doc/todo.txt
@@ -0,0 +1,110 @@
+*todo.txt*  To-do list syntax highlighting and mappings
+
+Author:  Teddy Wing <http://teddywing.com>
+License: GPLv3+
+Version: 0.0.1
+
+==============================================================================
+INTRODUCTION                                                            *todo*
+
+Syntax highlighting and mappings to view and manipulate to-do lists. Files
+should end in a `.todo` extension.
+
+==============================================================================
+EXAMPLE                                                         *todo-example*
+
+    - Regular priority to-dos are prefixed with a `- `
+    _ A low priority to-do
+    ! A high priority to-do
+    x A deleted to-do
+    S A partially completed to-do
+    v A completed to-do
+
+==============================================================================
+MAPPINGS                                                       *todo-mappings*
+
+				*todo-<Plug>TwodoNewTodoBelow*
+<Plug>TwodoNewTodoBelow
+	Add a new to-do below the current line.
+
+	Default: <leader>n
+
+				*todo-<Plug>TwodoNewTodoAbove*
+<Plug>TwodoNewTodoAbove
+	Add a new to-do above the current line.
+
+	Default: <leader>N
+
+				*todo-<Plug>TwodoMarkComplete*
+<Plug>TwodoMarkComplete
+	Mark the current to-do complete.
+
+	Default: <leader>c
+
+				*todo-<Plug>TwodoMarkDeleted*
+<Plug>TwodoMarkDeleted
+	Mark the current to-do deleted.
+
+	Default: <leader>d
+
+				*todo-<Plug>TwodoMarkPartiallyCompleted*
+<Plug>TwodoMarkPartiallyCompleted
+	Mark the current to-do partially complete.
+
+	Default: <leader>s
+
+				*todo-<Plug>TwodoRemoveOldTodos*
+<Plug>TwodoRemoveOldTodos
+	Remove todos marked complete and deleted.
+
+	Default: <leader>R
+
+				*todo-<Plug>TwodoEscalate*
+<Plug>TwodoEscalate
+	Increase the priority of the current to-do.
+
+	Default: <leader>=
+
+				*todo-<Plug>TwodoDescalate*
+<Plug>TwodoDescalate
+	Decrease the priority of the current to-do.
+
+	Default: <leader>-
+
+
+==============================================================================
+COLOURS                                                          *todo-colors*
+
+				*todo-todoUndone*
+todoUndone	A regular priority to-do.
+
+				*todo-todoImportant*
+todoImportant	To-do with important priority.
+
+				*todo-todoUnimportant*
+todoUnimportant	To-do with low priority.
+
+				*todo-todoCompleted*
+todoCompleted	Completed to-do.
+
+				*todo-todoDeleted*
+todoDeleted	Deleted to-do.
+
+
+==============================================================================
+LICENSE                                                         *todo-license*
+
+Vim-Twodo 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-Twodo 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-Twodo. If not, see <http://www.gnu.org/licenses/>.
+
+ vim:tw=78:ts=8:ft=help:norl:
-- 
cgit v1.2.3