Skip to content

Commit c2a80d2

Browse files
committed
enhancing readme a bit
1 parent 75c2730 commit c2a80d2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
= Vim plugin for saving syntax match rules
22

3+
== What is it good for
4+
5+
If you do log investigation it's handy to differentiate identifiers with colors. +
6+
When you close `Vim` and later open the log file again it's fine to have preserved the colors.
7+
38
== Quick howto
49

510
. <<install, install>> the syntax match plugin
11+
. open file with suffix `.log` or `.txt`
612
. use <<commands,command>> `:Y search_pattern` to highlight some text
7-
. <<basics,save syntax>> with `:SS` (or work with file of suffix `.log` or `.txt`)
13+
* you've used the prepared shortcuts for coloring log parts
814
. quit the file, then open it again
9-
* syntax is loaded from saved syntax file and restored (see <<how-works-internally>>)
15+
* syntax is loaded from a saved syntax file and restored for you (see <<how-works-internally>>)
1016

1117

1218
== What the plugin provides
@@ -213,7 +219,7 @@ Usage is like
213219

214220
The plugin adds special user function named `SCB` which you can run as `:SCB`
215221
and it's functionality is to run scroll bind on all opened windows.
216-
The user function does the same as `:windo set scb`.
222+
This user function does the same as when you run manually `:windo set scb`.
217223

218224

219225
[[usecase]]

0 commit comments

Comments
 (0)