summaryrefslogtreecommitdiff
path: root/doc/bujo.txt
blob: 83eb880f3a2a31eb26097b635e27553c79a0389b (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
61
62
63
64
*bujo.txt*                                *bujo.txt*
                        Bujo~
             Bullet Journal Vim Plugin~

Author: Jersey Fonseca <jerseyfonseca@gmail.com>

Version: 0.5

1. Overview
2. Features
3. FAQ

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

This plugin allows people to easily access and
manage todo lists for their projects.

You can access Todo lists of specific projects just
by being inside of that git repo. In addition, you
can access a general todo list from any folder.

You can find 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~
  
  * Open project specific todo:
    :Todo     // from inside project
  * Open general todo:
    :Todo g
  * Use mods
    :<mods> Todo
  * Insert a new task:
    nmap <C-Enter> <Plug>BujoAddTodoNormal
    imap <C-Enter> <Plug>BujoAddTodoInsert
  * Check off a task:
    nmap <C-BS> <Plug>BujoChecknormal
    imap <C-BS> <Plug>BujoCheckinsert
  * Change cache directory:
    let g:bujo#todo_file_path = $HOME . "/.cache/bujo"
  * Change window open width:
    let g:bujo#window_width = 40


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

Please always feel free to do make recommendations and
join me!