X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/ccd5654568bb362a15185bcf0c1dfa5cb9f3ace7..8fefa7358bf9f799c8a7d700b58a00362b26419e:/README.md diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 7c27d2d..dea2381 --- 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. + + Copyright © 2008-2019 Fundacja Nowoczesna Polska + + For full list of contributors see AUTHORS file. 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,20 +21,22 @@ 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: - * HTML4, XHTML 1.0 + * HTML4, XHTML 1.0 (?) * Plain text * EPUB (XHTML based) + * MOBI * print-ready PDF - -Other features: + * FB2 + +Other features: * extract DublinCore meta-data from documents; * extract marked "themes" from documents. @@ -58,7 +60,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 ------ @@ -82,13 +86,3 @@ To convert a file to PDF: To extract book fragments marked as "theme": bookfragments file1.xml [file2.xml ...] - - -Authors -------- -Originally written by Marek Stępniowski - -Later contributions: - - * Łukasz Rekucki - * Radek Czajka \ No newline at end of file