summaryrefslogtreecommitdiff
path: root/doc/bujo.txt
blob: 74af9425ee079096ec3b316444200a4d1a3a17ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
*bujo.txt*                                *bujo.txt*
                        Bujo~
             Bullet Journal Vim Plugin~

Author: Jersey Fonseca <jerseyfonseca@gmail.com>

Version: 0.1

1. Overview
2. Features
3. FAQ

=======================================================
                                        *bujo-overview*
1. Overview~

This plugin allows people to easily access and
manage a todo list.

You can stable versions of this plugin at: 

https://github.com/jfonseca8/vim-bujo

Feedback and bug reports are welcomed and encouraged.
If you want new features, please do let me know. I
would be honored at the opportunity to make a tool
better.

I built this because I wanted the ease of vim bindings
with the benefits of keeping a todo list on hand. It is
very simple and minimialist.

=======================================================
                                        *bujo-features*
2. Features~
  
  * Run:
    :Todo
  * Insert a new task:
    nmap <C-Enter> <Plug>bujo#AddTodoNormal
    imap <C-Enter> <Plug>bujo#AddTodoInsert
  * Check off a task:
    nmap <C-BS> <Plug>bujo#CheckTodoNormal
    imap <C-BS> <Plug>bujo#CheckTodoInsert
  * Change cache directory:
    let g:bujo#todo_file_path = $HOME . "/.cache/bujo"


=======================================================
                                           *bujo-notes*
3. Notes

I am not sure that writing this todo file into the root
directory is the best way to go about it. I have never
made anything like this, and couldn't find resources
that were helpful with how to handle such situations.

If this annoys anyone, please do let me know. I am
happy to change it, and happy to know if there are
better standardized ways to go about this