Added `README`.

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7711 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

4 files changed, 107 insertions, 2 deletions

diff --git a/sandbox/odf2docutils/README b/sandbox/odf2docutils/README
new file mode 100644
index 000000000..d38ac9a64
--- /dev/null
+++ b/sandbox/odf2docutils/README
@@ -0,0 +1,88 @@
+============
+odf2docutils
+============
+
+.. contents::
+
+What is odf2docutils?
+=====================
+
+`odf2docutils` is a tool to generate `Docutils XML`_ from `Open
+Document Format`_ (ODF_). This way you can create a `Docutils XML`_
+file from ODF_ input and then transform the result to
+reStructuredText_ by using `xml2rst`_.
+
+Using odf2docutils
+==================
+
+Use `odf2docutils` by calling ``odf2docutils.py`` on an ODF_ file. Run
+``odf2docutils --help`` for more information.
+
+Availability
+============
+
+`odf2docutils` is available through the `Docutils Subversion repository`_
+as part of the Docutils sandbox in ``sandbox/odf2docutils``.
+
+Moreover you can fetch it directly from the current maintainer at
+http://www.merten-home.de/FreeSoftware/odf2docutils/
+
+Installation
+============
+
+`odf2docutils` depends on the lxml_ package [#deb-lxml]_. Make sure
+this package is installed before running `odf2docutils`.
+
+After you obtained the package run ``python setup.py install``.
+
+.. [#deb-lxml] Under Debian based operating systems try ``apt-get
+   install python-lxml``.
+
+Copyright and license
+=====================
+
+Copyright (C) 2013 by Stefan Merten
+
+License is GPL_ v2 or later.
+
+Development
+===========
+
+Tests
+-----
+
+There are test suites in ``tests``. Use filterunit_ to run tests.
+
+ToDos
+-----
+
+So far only a small subset of ODF_ is supported. This may change over
+time.
+
+Implementation
+--------------
+
+The core of `odf2docutils` is implemented as an XSLT_ stylesheet
+called ``odf2docutils.xsl``. So far the script ``odf2docutils.py`` is
+only needed for handling ODF_ files and run the XSLT_ processor.
+
+.. ############################################################################
+
+.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+
+.. _Docutils XML: http://docutils.sourceforge.net/docs/ref/doctree.html
+
+.. _XSLT: http://www.w3.org/TR/1999/REC-xslt-19991116
+
+.. _Docutils Subversion repository: http://docutils.sourceforge.net/docs/dev/repository.html
+
+.. _GPL: http://www.gnu.org/copyleft/gpl.html
+
+.. _Open Document Format:
+.. _ODF: https://www.oasis-open.org/standards#opendocumentv1.2
+
+.. _lxml: http://codespeak.net/lxml/
+
+.. _filterunit: http://www.merten-home.de/FreeSoftware/filterunit/
+
+.. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/
diff --git a/sandbox/odf2docutils/global.log b/sandbox/odf2docutils/global.log
index ca0b99567..92081840b 100644
--- a/sandbox/odf2docutils/global.log
+++ b/sandbox/odf2docutils/global.log
@@ -1,4 +1,21 @@
 **************************************
+Date: Fri Aug  2 11:28:13 CEST 2013
+Author: stefan
+Tag: odf2docutils_1_33
+
+--------------------------------------
+Update of /home/stefan/vault/sm/odf2docutils
+In directory theowa:/home/stefan/free/odf2docutils
+
+Modified Files:
+	setup.py 
+Added Files:
+	README 
+
+--------------------------------------
+Log Message:
+Added README.
+**************************************
 Date: Thu Aug  1 20:09:38 CEST 2013
 Author: stefan
 Tag: odf2docutils_1_32
diff --git a/sandbox/odf2docutils/setup.py b/sandbox/odf2docutils/setup.py
index a85dd567f..c28a93e04 100755
--- a/sandbox/odf2docutils/setup.py
+++ b/sandbox/odf2docutils/setup.py
@@ -11,7 +11,7 @@ setup(name='odf2docutils',
       author_email='smerten@oekonux.de',
       url='http://docutils.sourceforge.net/sandbox/odf2docutils/',
       license='GPL 2',
-      requires=[ 'docutils', 'lxml' ],
+      requires=[ 'lxml' ],
       scripts=[ 'odf2docutils.py' ],
       packages=[ 'odf2docutilslib' ],
       package_data={ 'odf2docutilslib': [ 'odf2docutils.xsl' ], },
diff --git a/sandbox/odf2docutils/tag.log b/sandbox/odf2docutils/tag.log
index c08becf08..465dd8a88 100644
--- a/sandbox/odf2docutils/tag.log
+++ b/sandbox/odf2docutils/tag.log
@@ -1 +1 @@
-odf2docutils_1_32
+odf2docutils_1_33