wip change fb2 api

[librarian.git] / README.md

diff --git a/README.md b/README.md
old mode 100755 (executable)
new mode 100644 (file)
index e80922c..a64e37a
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
-Licence
-=======
-    
-    Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
-    
-    For full list of contibutors see AUTHORS section at the end. 
+License
+-------
+
+  ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
+
+    Copyright © 2008-2023 Fundacja Wolne Lektury <fundacja@wolnelektury.pl>
+
+    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
@@ -19,63 +21,68 @@ Licence
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-Librarian
-=========
-
-Librarian (*ang. bibliotekarz*) to biblioteka służąca do konwersji języka składu książek opartego na XML opracowanego przez Fundację Nowoczesna Polska na inne formaty.
+About
+------
 
-Obecnie obsługiwane są formaty:
+Librarian converts XML-based markup language used by WL for writing books to
+other formats, which are more suitable for presentation.
 
- * XML
- * TXT
- 
-Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur.
+Currently we support:
 
+ * HTML4, XHTML 1.0 (?)
+ * Plain text
+ * EPUB (XHTML based)
+ * MOBI
+ * print-ready PDF
+ * FB2
 
-Wymagania
----------
+Other features:
 
- * [lxml 2.2](http://codespeak.net/lxml/)
+ * extract DublinCore meta-data from documents;
+ * extract marked "themes" from documents.
 
- 
-Instalacja
-----------
-Zainstaluj biblioteki z sekcji *Wymagania* powyżej. Następnie rozpakuj archiwum z biblioteką librarian, przejdź w terminalu do rozpakowanego katalogu i wpisz:
 
-<pre>python setup.py install</pre>
+Dependencies
+------------
 
-Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz:
+ * 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>
 
-<pre>sudo python setup.py install</pre>
 
-Alternatywnie możesz zainstalować bibliotekę librarian w wybranym przez siebie katalogu. W takim wypadku należy użyć argumentu *prefix* do *setup.py*:
+Installation
+------------
 
-<pre>python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU</pre> 
+Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
 
-W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*.
+    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'.
 
-Sposób użycia
--------------
-Konwersja plików lektur do XHTML:
+Usage
+------
 
-<pre>book2html LEKTURA1 LEKTURA2...</pre>
+To convert a series of files to XHTML:
 
-Konwersja plików lektur do TXT:
+    book2html file1.xml [file2.xml ...]
 
-<pre>book2txt LEKTURA1 LEKTURA2...</pre>
+To convert a series of files to plain text:
 
-Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML:
+    book2txt file1.xml [file2.xml ...]
 
-<pre>bookfragments PLIK1 PLIK2...</pre>
+To convert a file to EPUB:
 
-Authors
--------
-Originally written by Marek Stępniowski <marek@stepniowski>;
-       
-Later contributions:
-    Łukasz Rekucki <lrekucki@gmail.com>
+    book2epub file.xml
 
+To convert a file to PDF:
 
+    book2pdf file.xml
 
+To extract book fragments marked as "theme":
 
+    bookfragments file1.xml [file2.xml ...]