X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/8f76c14aae6e491816a0c07ec7fe66119dd34716..db772f02e1800391c1699002e16729ab8872675e:/README.md?ds=sidebyside diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 0867419..c0e13e9 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ License ------- ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) - + Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska - - For full list of contributors see AUTHORS section at the end. + + For full list of contributors see AUTHORS section at the end. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by @@ -21,10 +21,10 @@ License along with this program. If not, see . -About +About ------ -Librarian converts XML-based markup language used by FNP for writing books to +Librarian converts XML-based markup language used by FNP for writing books to other formats, which are more suitable for presentation. Currently we support: @@ -33,8 +33,8 @@ Currently we support: * Plain text * EPUB (XHTML based) * print-ready PDF - -Other features: + +Other features: * extract DublinCore meta-data from documents; * extract marked "themes" from documents. @@ -45,8 +45,11 @@ Dependencies * lxml , version 2.2 or later * additional PDF converter dependencies: - * XeTeX + * 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 @@ -55,7 +58,9 @@ 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 ------