Skip to content

Commit

Permalink
enhancing readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
ochaloup committed May 2, 2018
1 parent 75c2730 commit c2a80d2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
= Vim plugin for saving syntax match rules

== What is it good for

If you do log investigation it's handy to differentiate identifiers with colors. +
When you close `Vim` and later open the log file again it's fine to have preserved the colors.

== Quick howto

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


== What the plugin provides
Expand Down Expand Up @@ -213,7 +219,7 @@ Usage is like

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


[[usecase]]
Expand Down

0 comments on commit c2a80d2

Please sign in to comment.