nota_red

[librarian.git] / README.md

diff --git a/README.md b/README.md
index ea80c92..7c27d2d 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -30,14 +30,10 @@ other formats, which are more suitable for presentation.
 Currently we support:
 
  * HTML4, XHTML 1.0
 Currently we support:
 
  * HTML4, XHTML 1.0

- * Plain text 
- 
-In the future, we plan to support:
-
+ * Plain text

  * EPUB (XHTML based)
  * EPUB (XHTML based)

- * print-ready PDF 
-
-
+ * print-ready PDF
+ 

 Other features: 
 
  * extract DublinCore meta-data from documents;
 Other features: 
 
  * extract DublinCore meta-data from documents;


@@ -48,6 +44,12 @@ Dependencies
 ------------
 
  * lxml <http://codespeak.net/lxml/>, version 2.2 or later
 ------------
 
  * lxml <http://codespeak.net/lxml/>, version 2.2 or later

+ * additional PDF converter dependencies:
+   * XeTeX with support for Polish language
+   * TeXML <http://getfo.org/texml/>
+   * recommended: morefloats LaTeX package, version >=1.0c
+     for dealing with documents with many motifs in one paragraph.
+     <http://www.ctan.org/tex-archive/help/Catalogue/entries/morefloats.html>

 
 
 Installation
 
 
 Installation


@@ -61,14 +63,22 @@ Librarian uses standard Python distutils for packaging. After installing all the
 Usage
 ------
 
 Usage
 ------
 

-To convert a series of file to XHTML:
+To convert a series of files to XHTML:

 
     book2html file1.xml [file2.xml ...]
 
 
     book2html file1.xml [file2.xml ...]
 

-To convert a series of file to plain text:
+To convert a series of files to plain text:

 
     book2txt file1.xml [file2.xml ...]
 
 
     book2txt file1.xml [file2.xml ...]
 

+To convert a file to EPUB:
+
+    book2epub file.xml
+
+To convert a file to PDF:
+
+    book2pdf file.xml
+

 To extract book fragments marked as "theme":
 
     bookfragments file1.xml [file2.xml ...]
 To extract book fragments marked as "theme":
 
     bookfragments file1.xml [file2.xml ...]