X-Git-Url: https://deadsoftware.ru/gitweb?p=bbdiff.git;a=blobdiff_plain;f=README;h=81432a6d14167c00e71816ca7bfd7d6dc2ddd693;hp=24217a5f6875293bee9d3550aa505bfd0fdae46a;hb=0ca83c247bc68e4844d5d35e356abbc5cbcd813d;hpb=efcd07aa70b1fa34cb8c13e57f3f6d78963cf825

diff --git a/README b/README
index 24217a5..81432a6 100644
--- a/README
+++ b/README
@@ -1,22 +1,67 @@
 BlackBox diffutils
 --------------------
 
-Clone of diff and patch utilites from *nix for BlackBox and its binary document format.
+Clone of diff, patch and diff3 utilites from *nix for BlackBox and its binary Compound Document format.
 
-Building
+
+Commands
+--------------------
+
+To use tools within Blackbox just compile DevDiff.
+
+DevDiff.Compare (guard TextCmds.FocusGuard)
+
+	Compare texts from two windows.
+	Can directly replace DevSearch.Compare in Dev/Rsrc/Menus.odc.
+
+
+^Q DevDiff.CompareThis <oldfile> <newfile> [">" <outfile>]
+
+	Compare two files and produce patch in unified diff format.
+
+
+^Q DevDiff.ApplyPatch <patchfile>
+
+	Read unified diff format and apply changes from it.
+
+
+^Q DevDiff.MergeThis <my> <old> <your> [">" <outfile>]
+
+	Read three files and do three-way merge like.
+
+
+Dedicated tool
 --------------------
 
-Just compile module DevDiff.
+You can read, create diffs and merge documents from command line using odctool.
+To build open OdctoolMain and execute commanders at the end of document.
+Call `odctoll.exe help` to learn how to use it.
+
+Warning: It tested only with wine and NOT tested on windows or native linux.
+
 
-Usage
+Integration with GIT
 --------------------
 
-See sources. Documentation not writed yet.
-Command DevDiff.CompareThis compare two files and produce patch in unified diff format.
-Command DevDiff.PatchThis read patch in unified diff format and apply changes from it.
+It is possible to integrate three-way merge with git.
+
+1. Open .git/config and add this lines:
+
+	[merge "odctool"]
+		name = BlackBox Compound Document merge driver
+		driver = /full/path/to/odctool merge -P %P %A %O %B %A
+
+2. Open/create .git/info/attributes and add this line:
+
+	*.odc merge=odctool
+
+Now when conflict occurs, it marked like diff3 directly in odc file.
+Checked not only text, but also views and formatting.
+
 
 Current state
 --------------------
 
-This is NOT final version of module DevDiff. It is NOT well tested, but it works. You are warned!
-Todo list see at the and of sources.
+This is NOT final version of module DevDiff and Odctool. It is NOT well tested, you are warned!
+Also, program and user interfaces can be changed later.
+Todo list see at the and of sources and build tools.