Skip to content

Commit 9ca12ee

Browse files
authored
Improve README.md
1 parent 1c8e17c commit 9ca12ee

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,40 @@ This simple syntax for vim allows for easy creation of simple TODO files.
44

55
![Preview](Images/Preview.jpg)
66

7-
Whitespaces don't matter and tabulation can be useful for tree-like structure:
7+
Start a line with one of these characters for to highlight it with various colors:
8+
| Character | Highlight Group |
9+
| --- | --------- |
10+
| `-` | Type |
11+
| `+` | Statement |
12+
| `!` | Special |
13+
| `?` | Constant |
14+
| `/` | Comment |
15+
16+
17+
Whitespaces don't matter and indentation can be useful to create a tree-like structure:
818

919
![Whitespaces don't matter](Images/Whitespaces.jpg)
1020

21+
All examples are shown in solarized light color palette. Colors depends on your color scheme.
22+
1123
## Installation
1224

13-
Move `todotxt.vim` to `~/vimfiles/syntax` (Windows) or `~/.vim/syntax` (Unix)
25+
<details>
26+
<summary>Use your plugin manager (recommended)</summary>
1427

15-
Also make sure that syntax is enabled in your `vimrc` file by `syntax enable`
28+
For example using [vim-plug](https://github.com/junegunn/vim-plug):
1629

17-
[More info about syntax files](https://vim.wikia.com/wiki/Creating_your_own_syntax_files)
30+
```viml
31+
Plug 'EtiamNullam/vim-todotxt-syntax'
32+
```
33+
</details>
1834

19-
All examples are shown in solarized light color palette. Unfortunately, right now colors will be off in other color schemes.
35+
<details>
36+
<summary>Manual</summary>
37+
38+
Move `todotxt.vim` to `~/vimfiles/syntax` (Windows) or `~/.vim/syntax` (Unix)
39+
</details>
40+
41+
Also make sure that syntax is enabled in your config by `syntax enable`
42+
43+
[More info about syntax files](https://vim.wikia.com/wiki/Creating_your_own_syntax_files)

0 commit comments

Comments
 (0)