From: Łukasz Rekucki Date: Fri, 19 Mar 2010 17:52:13 +0000 (+0100) Subject: Translated README. X-Git-Tag: 1.7~294 X-Git-Url: https://git.mdrn.pl/librarian.git/commitdiff_plain/95e4429c3619b4ed91fa1a392ec0b34410f412a7?ds=inline Translated README. --- diff --git a/README.md b/README.md index e80922c..a918a02 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -Licence -======= +License +------- Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska - For full list of contibutors 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 @@ -19,63 +19,61 @@ Licence along with this program. If not, see . -Librarian -========= +About +------ -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. +Librarian converts XML-based markup language used by FNP for writing books to other formats, whiche are more subtable for presentation. -Obecnie obsługiwane są formaty: +Currently we support: - * XML - * TXT + * HTML4, XHTML 1.0 + * Plain text -Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur. +In the future, we plan to support: + * EPUB (XHTML based) + * print-ready PDF -Wymagania ---------- - * [lxml 2.2](http://codespeak.net/lxml/) +Other features: + + * 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: -
python setup.py install
+Dependencies +------------ -Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz: + * [lxml] (http://codespeak.net/lxml/) >= 2.2 -
sudo python setup.py install
-Alternatywnie możesz zainstalować bibliotekę librarian w wybranym przez siebie katalogu. W takim wypadku należy użyć argumentu *prefix* do *setup.py*: +Installation +------------ -
python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU
+Librarian uses standard Python distutils for packaging. After installing all the dependencies just run: + + python setup.py install + -W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*. +Usage +------ +To convert a series of file to XHTML: -Sposób użycia -------------- -Konwersja plików lektur do XHTML: + book2html file1.xml [file2.xml ...] -
book2html LEKTURA1 LEKTURA2...
+To convert a series of file to plain text: -Konwersja plików lektur do TXT: + book2txt file1.xml [file2.xml ...] -
book2txt LEKTURA1 LEKTURA2...
+To extract book fragments marked as "theme": -Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML: + bookfragments file1.xml [file2.xml ...] -
bookfragments PLIK1 PLIK2...
Authors ------- -Originally written by Marek Stępniowski ; +Originally written by Marek Stępniowski Later contributions: - Łukasz Rekucki - - - - + Łukasz Rekucki \ No newline at end of file diff --git a/setup.py b/setup.py index 13a953a..0d795ae 100644 --- a/setup.py +++ b/setup.py @@ -11,8 +11,7 @@ setup( author_email='marek@stepniowski.com', mantainer='Łukasz Rekucki', mantainer_email='lrekucki@gmail.com', - url='http://redmine.nowoczesnapolska.org.pl/', - + url='http://github.com/fnp/librarian', packages=['librarian'], package_data = {'librarian': ['xslt/*.xslt']}, include_package_data=True,