From af33a8a43dc780b2fda34129a273ab2bf792fde6 Mon Sep 17 00:00:00 2001 From: grubert Date: Fri, 6 Jan 2012 18:51:12 +0000 Subject: [PATCH] readd README.txt git-svn-id: https://docutils.svn.sourceforge.net/svnroot/docutils/trunk@7309 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- sandbox/rstdiff/README.txt | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 sandbox/rstdiff/README.txt diff --git a/sandbox/rstdiff/README.txt b/sandbox/rstdiff/README.txt new file mode 100644 index 000000000..0d7c42fec --- /dev/null +++ b/sandbox/rstdiff/README.txt @@ -0,0 +1,23 @@ +============== +rstdiff README +============== + +Overview +======== + +`rstdiff.py` takes two reStructuredText documents as input, does a +structural comaprison on them and produces an annotated result +highlighting the changes. `rstdiff.py` "understands" reStructuredText +and therefore is able to care for the subtleties of such a comparison +the result is usually much more useful than a plain source diff. + +The result is then written by a Docutils writer. Use the `--writer` +option to select a writer for the result. + +Installation +============ + +`rstdiff.py` uses the standard Distutils package. Thus the +installation is done with something like:: + + python setup.py install -- 2.11.4.GIT