From 10777c32f603c187316d2c1cacc665c7f34dd0b7 Mon Sep 17 00:00:00 2001 From: Mirek Kratochvil Date: Tue, 14 Oct 2025 14:07:40 +0200 Subject: actually make the vim syntax work nicely + document it --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'README.md') 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 -- cgit v1.2.3