added mode that show invisible spaces/tabs

[bbdiff.git] / README

diff --git a/README b/README
index a7ec05ec822cc20d7fc6edb89766f9029714f1a8..bf0fb5ab025f9bc4198e887acac9e44fae5e8371 100644 (file)
--- a/README
+++ b/README
@@ -33,7 +33,7 @@ To build it, open DiffMain and execute commanders at the end of document.
 Call `odctool help` to learn how to use it.
 
 
-Integration with Git
+Integration with git
 --------------------
 
 1. Compile odctool.
@@ -41,16 +41,16 @@ Integration with Git
 2. Create script odctool-gitdiff:
 
        #! /bin/sh
-       odctool diff -C -p "$1" "$2" "$5"
+       odctool diff -x -X -E -C -p "$1" "$2" "$5"
 
 3. Add to .git/config:
 
        [merge "odctool"]
                name = BlackBox Compound Document merge driver
-               driver = /path/to/odctool merge -p %P -o %A %A %O %B
+               driver = odctool merge -o %A -p HEAD %A -p PARENT %O -p BRANCH %B
        [diff "odctool"]
                name = BlackBox Compound Document diff driver
-               command = /path/to/odctool-gitdiff
+               command = odctool-gitdiff
 
 4. Add to .git/info/attributes:
 
@@ -63,7 +63,8 @@ Integration with Git
        *.osf
        odc[0-9][0-9][0-9][0-9][0-9]
 
-Now you can see diffs using `git diff' and resolve conflicts from BlackBox.
+
+Now you can see diffs using `git diff' and resolve conflicts without converting odc to text.
 
 
 Integration with ranger
@@ -77,15 +78,15 @@ Integration with ranger
                        ...
 
                        # BlackBox Compound Document
-                       odc)
-                               odctool -C cat "${FILE_PATH}" && exit 5
-                               exit 1;;
+                       odc)
+                               odctool -C -X cat "${FILE_PATH}" && exit 5
+                               exit 1;;
                esac
        }
 
 2. To open/read documents add to $HOME/.config/ranger/rifle.conf:
 
-       ext odc, has odctool, terminal, file = odctool -C cat "$1" | less --tabs=2 -S
+       ext odc, has odctool, terminal, file = odctool -C -X cat "$1" | less --tabs=2 -S
 
 
 Current state