forked from jodosha/vim-devnotes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdevnotes.txt
108 lines (65 loc) · 3.83 KB
/
devnotes.txt
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
*devnotes.txt* Quick development notes
CONTENTS
===========================================================================
1. Introduction |devnotes|
2. Requirements |devnotes-requirements|
3. Installation |devnotes-installation|
4. Usage |devnotes-usage|
5. Mappings |devnotes-mappings|
6. Configuration |devnotes-configuration|
7. Feedback |devnotes-feedback|
8. Credits |devnotes-credits|
9. Contributors |devnotes-contributors|
10. License |devnotes-license|
Introduction *:DevNotes* *devnotes*
===========================================================================
DevNotes opens a buffer where to write down quick development notes.
Requirements *devnotes-requirements*
===========================================================================
This plugin requires an UNIX environment.
Installation *devnotes-installation*
===========================================================================
Copy all files to your ~/.vim directory or use one of the following Vim
plugin managers like a decent modern Vimmist:
- pathongen: https://github.com/tpope/vim-pathogen
- Vundle: https://github.com/gmarik/vundle
- NeoBundle: https://github.com/Shougo/neobundle.vim
- VAM: https://github.com/MarcWeber/vim-addon-manager
Usage *devnotes-usage*
===========================================================================
Open a split with notes for the current project:
:call DevNotes()
In order to have a quick feedback about how many notes are still pending,
add to your statusline:
%{devnotes#statusline()}
Mapping *devnotes-mapping*
===========================================================================
The default mapping is:
<Leader>dn
Configuration *devnotes-configuration*
===========================================================================
Options~
Set the following variable in ~/.vimrc to control the behaviour of
DevNotes.
*g:devnotes_directory*
g:devnotes_directory string (default current project root)
Set a valid path where all the note files will
be stored.
*g:devnotes_file*
g:devnotes_file string (default '.devnotes')
Set a valid file name for the notes file.
Feedback *devnotes-feedback*
===========================================================================
Feel free to create an issue at
https://github.com/jodosha/vim-devnotes/issues
Credits *devnotes-credits*
===========================================================================
- Rein Henrichs (@reinh) for the documentation template.
Contributors *devnotes-contributors*
===========================================================================
- Luca Guidi (@jodosha)
License *devnotes-license*
===========================================================================
MIT license: http://opensource.org/licenses/MIT
---------------------------------------------------------------------------
vim:tw=75:sts:ts=2:ft=help: