Skip to content

Commit b0a43c5

Browse files
aserebryakovaserebryakov
committed
Updates documentation files.
1 parent 8f14df5 commit b0a43c5

File tree

2 files changed

+201
-8
lines changed

2 files changed

+201
-8
lines changed

‎README.md

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,81 @@
1-
# vim-todo-lists
1+
vim-todo-lists
2+
==============
23

3-
Vim plugin for TODO lists creation and management.
4+
**vim-todo-lists** is a Vim plugin for TODO lists management.
45

5-
## Motivation
6+
Installation
7+
------------
68

7-
Create a simple in-editor tool for handling TODO lists that will have the
8-
following features:
9+
#### Install vim-todo-lists
910

10-
* Easy create/updated/delete operations on TODO items
11-
* Easy navigation between TODO items
12-
* Easy TODO lists management (e.g. create new list and archive an old one)
11+
##### Pathogen
12+
13+
$ cd ~/.vim/bundle
14+
$ git clone https://github.com/aserebryakov/vim-todo-lists.git
15+
16+
##### NeoBundle
17+
18+
NeoBundle 'aserebryakov/vim-todo-lists'
19+
20+
##### Without plugin manager
21+
22+
Clone or download this repository and copy its contents to your `~/.vim/`
23+
directory.
24+
25+
Usage
26+
-----
27+
28+
Plugin is automatically applied for files with `.todo` extension.
29+
30+
##### Key bindings
31+
32+
###### Item editing mode
33+
34+
* `j` - go to next item
35+
* `k` - go to previous item
36+
* `o` - create new item above the cursor
37+
* `O` - create new item below the cursor
38+
* `<Space>` - toggle current item
39+
* `<CR>` - create new item in `insert mode`
40+
* `<leader>e` - switch to normal editing mode
41+
42+
###### Normal editing mode
43+
44+
* `j`, `k`, `o`, `O`, `<CR>` - no special behavior
45+
* `<Space>` - toggle current item
46+
* `<leader>e` - switch to item editing mode
47+
48+
Future features
49+
---------------
50+
51+
* TODO lists folder selection
52+
* Create new TODO list
53+
* Archive current TODO list in the folder
54+
* Show archived lists
55+
* Open list from archive
56+
57+
Contribution
58+
------------
59+
60+
Source code and issues are hosted on GitHub:
61+
62+
https://github.com/aserebryakov/vim-todo-lists
63+
64+
License
65+
-------
66+
67+
[MIT License](https://opensource.org/licenses/MIT)
68+
69+
Changelog
70+
---------
71+
72+
#### 0.1.0
73+
74+
* Easy navigation in TODO list
75+
* Easy adding new items
76+
* Easy items toggling
77+
78+
Credits
79+
-------
80+
81+
* Alexander Serebryakov, author ([GitHub](https://github.com/aserebryakov))

‎doc/vim-todo-lists.txt

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
*vim-todo-lists.txt* Version 0.1.0
2+
*vim-todo-lists*
3+
4+
Plugin for TODO lists management.
5+
6+
==============================================================================
7+
CONTENTS *VimTodoListsContents*
8+
9+
1. Introduction .... |VimTodoListsIntroduction|
10+
2. Installation .... |VimTodoListsInstallation|
11+
3. Usage ........... |VimTodoListsUsage|
12+
4. Contribution .... |VimTodoListsContribution|
13+
5. Future Features.. |VimTodoListsFutureFeatures|
14+
6. License ......... |VimTodoListsLicense|
15+
7. Changelog ....... |VimTodoListsChangelog|
16+
8. Credits ......... |VimTodoListsCredits|
17+
18+
==============================================================================
19+
1. Introduction *VimTodoListsIntroduction*
20+
21+
vim-todo-lists plugin is intended for TODO lists management.
22+
23+
Current version contains only key bindings that simplify the navigation
24+
between TODO list (should have '.todo' extension) items, creation and update.
25+
26+
See |VimTodoListsFutureFeatures|.
27+
28+
==============================================================================
29+
2. Installation *VimTodoListsInstallation*
30+
31+
Pathogen:
32+
>
33+
$ cd ~/.vim/bundle
34+
$ git clone https://github.com/aserebryakov/vim-todo-lists.git
35+
<
36+
NeoBundle:
37+
>
38+
NeoBundle 'aserebryakov/vim-todo-lists'
39+
<
40+
Without plugin manager:
41+
42+
Clone or download this repository and copy its contents to your ~/.vim/
43+
directory.
44+
45+
==============================================================================
46+
3. Usage *VimTodoListsUsage*
47+
48+
Plugin is automatically applied for files with `.todo` extension.
49+
50+
Key bindings in item editing mode
51+
---------------------------------
52+
53+
* j - go to next item
54+
* k - go to previous item
55+
* o - create new item above the cursor
56+
* O - create new item below the cursor
57+
* <Space> - toggle current item
58+
* <CR> - create new item in insert mode
59+
* <leader>e - switch to normal editing mode
60+
61+
Key bindings in normal editing mode
62+
---------------------------------
63+
64+
* j, k, o, O, <CR> - no special behavior
65+
* <Space> - toggle current item
66+
* <leader>e - switch to item editing mode
67+
68+
==============================================================================
69+
4. Future Features *VimTodoListsFutureFeatures*
70+
71+
* TODO lists folder selection
72+
* Create new TODO list
73+
* Archive current TODO list in the folder
74+
* Show archived lists
75+
* Open list from archive
76+
77+
==============================================================================
78+
5. Contribution *VimTodoListsContribution*
79+
80+
Source code and issues are hosted on GitHub:
81+
82+
https://github.com/aserebryakov/vim-todo-lists
83+
84+
==============================================================================
85+
6. License *VimTodoListsLicense*
86+
87+
MIT License
88+
89+
Copyright (c) 2017 Alexander Serebryakov (alex.serebr@gmail.com)
90+
91+
Permission is hereby granted, free of charge, to any person obtaining a copy
92+
of this software and associated documentation files (the "Software"), to deal
93+
in the Software without restriction, including without limitation the rights
94+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
95+
copies of the Software, and to permit persons to whom the Software is
96+
furnished to do so, subject to the following conditions:
97+
98+
The above copyright notice and this permission notice shall be included in all
99+
copies or substantial portions of the Software.
100+
101+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
102+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
103+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
104+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
105+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
106+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
107+
SOFTWARE.
108+
109+
==============================================================================
110+
7. Changelog *VimTodoListsChangelog*
111+
112+
0.1.0
113+
114+
* Easy navigation in TODO list
115+
* Easy adding new items
116+
* Easy items toggling
117+
118+
==============================================================================
119+
8. Credits *VimTodoListsCredits*
120+
121+
* Alexander Serebryakov (author) https://github.com/aserebryakov
122+
123+
==============================================================================
124+
# vim:tw=78:ts=8:ft=help:norl:

0 commit comments

Comments
 (0)