fnp / librarian.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
epub fix
[librarian.git] / README.md
diff --git a/README.md b/README.md
index d19505d..0867419 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 License
 -------
 License
 -------
+
+  ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
     
     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
     
     
     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
     
@@ -28,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;
@@ -45,7 +43,10 @@ Other features:
 Dependencies
 ------------
 
 Dependencies
 ------------
 
- * [lxml] (http://codespeak.net/lxml/) >= 2.2
+ * lxml <http://codespeak.net/lxml/>, version 2.2 or later
+ * additional PDF converter dependencies:
+   * XeTeX
+   * TeXML <http://getfo.org/texml/>
 
 
 Installation
 
 
 Installation
@@ -59,14 +60,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 ...]
@@ -78,4 +87,5 @@ Originally written by Marek Stępniowski <marek@stepniowski.com>
        
 Later contributions:
 
        
 Later contributions:
 
- * Łukasz Rekucki <lrekucki@gmail.com>
\ No newline at end of file
+ * Łukasz Rekucki <lrekucki@gmail.com>
+ * Radek Czajka <radek.czajka@gmail.com>
\ No newline at end of file