aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMirek Kratochvil <miroslav.kratochvil@uni.lu>2025-10-14 14:07:40 +0200
committerMirek Kratochvil <miroslav.kratochvil@uni.lu>2025-10-14 14:07:40 +0200
commit10777c32f603c187316d2c1cacc665c7f34dd0b7 (patch)
tree244722cfb82754d13a4aecfab3273e426151d140 /README.md
parent6beaeec8e773d8494d084ce49d87c62929da5b2e (diff)
downloadwerge-10777c32f603c187316d2c1cacc665c7f34dd0b7.tar.gz
werge-10777c32f603c187316d2c1cacc665c7f34dd0b7.tar.bz2
actually make the vim syntax work nicely + document it
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4c12478..9683fa4 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,16 @@ In any other case, you may set up a path to any compatible `diff` and `patch`
(or suitable wrapper scripts) via environment variables `WERGE_DIFF` and
`WERGE_PATCH`. (If required, the same applies for `WERGE_GIT`.)
+### Editor integration
+
+There's a `vim` syntax highlighting file in `vim/werge.vim`. To install, simply
+copy it to your local `vim` syntax configuration directory (usually to
+`~/.vim/syntax/werge.vim`). Then, you can activate the syntax in vim with:
+
+```
+:set syn=werge
+```
+
## Demo
##### Original (`old` file):
@@ -74,7 +84,8 @@ Violets are blue.
Patching is hard.<<<<< I still||||| I=====
I>>>>> cannot do verses.
```
-(NOTE: option `-G` gives nicely colored output that is much easier to read.)
+(NOTE: option `-G` gives nicely colored output that is much easier to read.
+Alternatively you can install the syntax highlighting for `vim`.)
##### Merge with separate space resultion
Adding option `-s` to `werge merge` causes it to resolve space conflicts