From bac77ce0965ab2282ee3173afef4de151b7db8fa Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sun, 4 Oct 2020 12:50:28 +0200 Subject: Add documentation --- doc/git_todo.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ doc/tags | 7 +++++++ 2 files changed, 54 insertions(+) create mode 100644 doc/git_todo.txt create mode 100644 doc/tags diff --git a/doc/git_todo.txt b/doc/git_todo.txt new file mode 100644 index 0000000..bac5ebb --- /dev/null +++ b/doc/git_todo.txt @@ -0,0 +1,47 @@ +*git_todo.txt* Interact with git-todo + +Author: Teddy Wing +License: GPLv3+ +Version: 0.0.1 + +============================================================================== +INTRODUCTION *git-todo-introduction* + +Use the 'git todo' command to search for TODO lines and load them into the +quickfix list. + +============================================================================== +COMMANDS *git-todo-commands* + + *:GitTodo* +:GitTodo [ref] + Find TODO lines and load them into the quickfix list. + + When [ref] is given, searches for all TODOs since [ref]. + +============================================================================== +SETTINGS *git-todo-settings* + + *g:git_todo_default_ref* +g:git_todo_default_ref + The default base ref to compare against. + +============================================================================== +LICENSE *git-todo-license* + +Copyright (c) 2020 Teddy Wing + +Git-Todo 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. + +Git-Todo 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 Git-Todo. If not, see . + + vim:tw=78:ts=8:ft=help:norl: diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..e8b1029 --- /dev/null +++ b/doc/tags @@ -0,0 +1,7 @@ +:GitTodo git_todo.txt /*:GitTodo* +g:git_todo_default_ref git_todo.txt /*g:git_todo_default_ref* +git-todo-commands git_todo.txt /*git-todo-commands* +git-todo-introduction git_todo.txt /*git-todo-introduction* +git-todo-license git_todo.txt /*git-todo-license* +git-todo-settings git_todo.txt /*git-todo-settings* +git_todo.txt git_todo.txt /*git_todo.txt* -- cgit v1.2.3