X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/3f007696b61ee78291def21c0dca98f94524a943..5c8b83a904d5dd988c0bfd86729b91a1ac763164:/README.md?ds=sidebyside
diff --git a/README.md b/README.md
index a84d45f..7588245 100755
--- 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
- * Plain text
-
-In the future, we plan to support:
-
+ * Plain text
* EPUB (XHTML based)
- * print-ready PDF
-
-
+ * print-ready PDF
+
Other features:
* extract DublinCore meta-data from documents;
@@ -48,6 +44,12 @@ Dependencies
------------
* lxml , version 2.2 or later
+ * additional PDF converter dependencies:
+ * XeTeX with support for Polish language
+ * TeXML
+ * recommended: morefloats LaTeX package, version >=1.0c
+ for dealing with documents with many motifs in one paragraph.
+
Installation
@@ -56,19 +58,29 @@ Installation
Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
python setup.py install
-
+
+PDF converter also needs the Junicode-WL fonts (librarian/pdf/JunicodeWL-*.ttf) installed.
+In Debian/Ubuntu, put those files in ~/.fonts/ and run `fc-cache'.
Usage
------
-To convert a series of file to XHTML:
+To convert a series of files to XHTML:
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 ...]
+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 ...]
@@ -80,4 +92,5 @@ Originally written by Marek StÄpniowski
Later contributions:
- * Åukasz Rekucki
\ No newline at end of file
+ * Åukasz Rekucki
+ * Radek Czajka
\ No newline at end of file