summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJersey <fonseca@uchicago.edu>2020-06-24 20:37:08 +0000
committerJersey <fonseca@uchicago.edu>2020-06-24 20:37:08 +0000
commit6b118944809f42d3af2a1b20f71f1aad580dc08d (patch)
treef653b37999204ae5a3ce813d674c1f71f35f6efe
parent90e5518188c66bbdb40398a7f0c88ca1f1115958 (diff)
First release
-rw-r--r--README.md55
-rw-r--r--doc/bujo.txt55
-rw-r--r--plugin/bujo.vim12
3 files changed, 109 insertions, 13 deletions
diff --git a/README.md b/README.md
index 1d95ccd..347100b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
1# vim-bullet-journal 1### vim-bujo
2I like bullet journals. I like vim. 2
3This plugin allows people to easily access and manage a minimalist todo list from vim.
4
5
6## Installation
7
8If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github.
9
10To install the stable version of the plugin, if using [vim-plug], put this in your `vimrc`/`init.vim`:
11
12```
13Plug 'jfonseca8/vim-bujo'
14```
15
16
17## Use
18
19* Conveniently open your todo list in vim
20 - Run :Todo
21* Easily insert a new task
22 - Press <Ctrl-Enter>
23* Easily check off a task
24 - Press <Ctrl-Backspace>
25
26
27## Screenshots
28
29This gif shows how the TODO list opens up in vim.
30
31We can also see simple controls used to manage the task list itself.
32
33## Notes
34
35Feedback and bug reports are welcomed and encouraged.
36If you want new features, please do let me know. I
37would be honored at the opportunity to make a tool
38better for the community.
39
40I built this because I wanted the ease of vim bindings
41with the benefits of keeping a todo list on hand. It is
42very simple and minimialist.
43
44I plan to add diary capabilities, calendar views, history,
45and all the fun little quotes and activities that make actual
46bullet journaling fun!
47
48If you would like to work on this project with me, please
49reach out to me on [twitter]
50
51
52[twitter]: https://twitter.com/FonsecaJersey
53[vim-plug]: https://github.com/junegunn/vim-plug
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
diff --git a/plugin/bujo.vim b/plugin/bujo.vim
index cc8a84e..9531421 100644
--- a/plugin/bujo.vim
+++ b/plugin/bujo.vim
@@ -1,17 +1,7 @@
1autocmd BufWritePre,FileWritePre todo.md ks|call LastMod()|'s
2fun LastMod()
3 if line("$") > 20
4 let l = 20
5 else
6 let l = line("$")
7 endif
8 exe "1," . l . "g/Date: /s/Date: .*/Date: " .
9 \ strftime("%Y %b %d")
10endfun
11
12"Make bujo directory if it doesn't exist" 1"Make bujo directory if it doesn't exist"
13if empty(glob('~/bujo')) 2if empty(glob('~/bujo'))
14 call mkdir($HOME . '/bujo', 'p') 3 call mkdir($HOME . '/bujo', 'p')
4
15endif 5endif
16 6
17" Open the bujo todo list file 7" Open the bujo todo list file