Version 1.2.1.

[librarian.git] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..3debf76
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,49 @@
+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.
+
+Obecnie obsługiwane są formaty:
+
+ * XML
+ * TXT
+ 
+Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur.
+
+
+Wymagania
+---------
+
+ * [lxml 2.2](http://codespeak.net/lxml/)
+
+ 
+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>
+
+Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz:
+
+<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*:
+
+<pre>python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU</pre> 
+
+W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*.
+
+
+Sposób użycia
+-------------
+Konwersja plików lektur do XHTML:
+
+<pre>book2html LEKTURA1 LEKTURA2...</pre>
+
+Konwersja plików lektur do TXT:
+
+<pre>book2txt LEKTURA1 LEKTURA2...</pre>
+
+Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML:
+
+<pre>bookfragments PLIK1 PLIK2...</pre>
+