summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/bujo.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/bujo.txt b/doc/bujo.txt
new file mode 100644
index 0000000..c74d128
--- /dev/null
+++ b/doc/bujo.txt
@@ -0,0 +1,55 @@
1*bujo.txt* *bujo.txt*
2 Bujo~
3 Bullet Journal Vim Plugin~
4
5Author: Jersey Fonseca <jerseyfonseca@gmail.com>
6
7Version: 0.1
8
91. Overview
102. Features
113. FAQ
12
13=======================================================
14 *bujo-overview*
151. Overview~
16
17This plugin allows people to easily access and
18manage a todo list.
19
20You can stable versions of this plugin at:
21
22https://github.com/jfonseca8/vim-bujo
23
24Feedback and bug reports are welcomed and encouraged.
25If you want new features, please do let me know. I
26would be honored at the opportunity to make a tool
27better.
28
29I built this because I wanted the ease of vim bindings
30with the benefits of keeping a todo list on hand. It is
31very simple and minimialist.
32
33=======================================================
34 *bujo-features*
352. Features~
36
37 * Conveniently open your todo list in vim
38 - Run :Todo
39 * Easily insert a new task
40 - Press <Ctrl-Enter>
41 * Easily check off a task
42 - Press <Ctrl-Backspace>
43
44=======================================================
45 *bujo-notes*
463. Notes
47
48I am not sure that writing this todo file into the root
49directory is the best way to go about it. I have never
50made anything like this, and couldn't find resources
51that were helpful with how to handle such situations.
52
53If this annoys anyone, please do let me know. I am
54happy to change it, and happy to know if there are
55better standardized ways to go about this