X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/9910cd8ebdd584d75b86686f66241eff86f3ac8c..2f46024c4c5987f8ae35b5dfaaf13569327bc46b:/README
diff --git a/README b/README
index 4404affc8..0a02dd70e 100644
--- a/README
+++ b/README
@@ -1,27 +1,106 @@
Dependencies
============
-
- * `Django 1.0 `_ (application framework)
- * `lxml 2.0.0 `_ (for importing books)
-
-
+
+ * [Django 1.0](http://djangoproject.com/) (application framework)
+ * [lxml 2.0.0](http://codespeak.net/lxml/) (for importing books)
+ * Python libraries from lib directory
+ * Django applications from apps directory
+
+
+How to deploy
+=============
+
+Just execute this commands:
+
+ cd wolnelektury.pl
+ source setpythonpath.sh
+ cd wolnelektury
+ ./manage.py syncdbc
+ ./manage.py importbooks ../books/01 ../books/02 ../books/03
+ ../setmainpage.py
+
+[TODO]
+
+
Numbering
=========
Co numerujemy
1. W utworach wierszowanych każdy wers,
- * przy czym powinien pokazywaÄ siÄ co 5 numer wersu
- * utwory wierszowane tzn. wiersze liryczne, poematy prozÄ
, powieÅci poetyckie, dramaty wierszowane itp.; należÄ
tu np. âPieÅniâ Kochanowskiego, liryki LeÅmiana, âGiaurâ Byrona, âPan Tadeuszâ Mickiewicza, âBalladynaâ SÅowackiego i in.
- * NIE numerujemy wersów utworów liczÄ
cych sobie mniej niż 5 wersów
- * za to wskazujemy 5 i 10 wers w utworach, które z zasady liczÄ
sobie zawsze staÅÄ
liczbÄ wersów â tzn. sonety)
+ * przy czym powinien pokazywaÄ siÄ co 5 numer wersu
+ * utwory wierszowane tzn. wiersze liryczne, poematy prozÄ
, powieÅci poetyckie, dramaty wierszowane itp.; należÄ
tu np. âPieÅniâ Kochanowskiego, liryki LeÅmiana, âGiaurâ Byrona, âPan Tadeuszâ Mickiewicza, âBalladynaâ SÅowackiego i in.
+ * NIE numerujemy wersów utworów liczÄ
cych sobie mniej niż 5 wersów
+ * za to wskazujemy 5 i 10 wers w utworach, które z zasady liczÄ
sobie zawsze staÅÄ
liczbÄ wersów â tzn. sonety)
2. W utworach prozÄ
, każdy akapit (wyróżniony wciÄciem akapitowym),
- * przy czym każdy numer akapitu powinien siÄ wyÅwietlaÄ, uÅatwiajÄ
c orientacjÄ w tekÅcie
- * do utworów prozÄ
należÄ
np. opowiadania, powieÅci, âKsiÄgi narodu polskiego i pielgrzymstwa polskiegoâ Mickiewicza, dramaty prozÄ
takie jak âMoralnoÅÄ Pani Dulskiejâ Zapolskiej
- * NIE numerujemy w dramatach: list dialogowych, nagÅówków (numer aktu, sceny, osoba), «wers_cd» ani didaskaliów â tylko goÅy tekst.
- * NIE numerujemy nagÅówków i tytuÅów w opowiadaniach, nowelach, legendach i powieÅciach
- *tam, gdzie akapit jest przerwany cytatem i nastÄpnie kontynuowany bez wciÄcia akapitowego (akap_cd» â liczymy go razem z cytatem jako jeden numer
+ * przy czym każdy numer akapitu powinien siÄ wyÅwietlaÄ, uÅatwiajÄ
c orientacjÄ w tekÅcie
+ * do utworów prozÄ
należÄ
np. opowiadania, powieÅci, âKsiÄgi narodu polskiego i pielgrzymstwa polskiegoâ Mickiewicza, dramaty prozÄ
takie jak âMoralnoÅÄ Pani Dulskiejâ Zapolskiej
+ * NIE numerujemy w dramatach: list dialogowych, nagÅówków (numer aktu, sceny, osoba), «wers_cd» ani didaskaliów â tylko goÅy tekst.
+ * NIE numerujemy nagÅówków i tytuÅów w opowiadaniach, nowelach, legendach i powieÅciach
+ * tam, gdzie akapit jest przerwany cytatem i nastÄpnie kontynuowany bez wciÄcia akapitowego (akap_cd» â liczymy go razem z cytatem jako jeden numer
3. W dramatach numeracja zamyka siÄ w ramach jednego aktu
4. W utworach mieszanych â pisanych na przemian wierszem i prozÄ
(np. dramaty Shakespeare'a) numerujemy w czÄÅci wierszowanej każdy wers (wyÅwietlajÄ
c co 5), a w czÄÅci prozÄ
â kolejne akapity
5. UstalonÄ
tradycyjnie numeracjÄ ma jedynie âBibliaâ i tych ustaleÅ siÄ trzymamy
+
+Używany kod open-source
+=======================
+
+django
+------
+ - ŹródÅa: [djangoproject.com](http://www.djangoproject.com/)
+ - Autorzy: [wielu autorów](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
+ - Licencja: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
+ - Typ: framework
+
+django-chunks
+-------------
+ - ŹródÅa: [Google Code](http://code.google.com/p/django-chunks/)
+ - Autorzy: Clint Ecker
+ - Licencja: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
+ - Typ: biblioteka (aplikacja django)
+
+django-pagination
+-----------------
+ - ŹródÅa: [Google Code](http://code.google.com/p/django-pagination/)
+ - Autorzy: James Tauber , leidel@gmail.com
+ - Licencja: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
+ - Typ: biblioteka (aplikacja django)
+
+django-compress
+---------------
+ - ŹródÅa: [Google Code](http://code.google.com/p/django-compress/)
+ - Autorzy: Andreas Pelme
+ - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
+ - Typ: biblioteka (aplikacja django)
+
+django-newtagging
+-----------------
+ - ŹródÅa: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
+ - Autorzy: Marek StÄpniowski
+ - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
+ - Typ: biblioteka (aplikacja django)
+ - Nota: Aplikacja wzorowana na [django-tagging](http://code.google.com/p/django-tagging/), która jest również wydana na licencji [MIT](http://www.opensource.org/licenses/mit-license.php) OkoÅo poÅowa kodu jest dzielona.
+
+feedparser
+----------
+ - ŹródÅa: [Google Code](http://code.google.com/p/feedparser/)
+ - Autorzy: Mark Pilgrim
+ - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
+ - Typ: biblioteka
+
+markupstring
+------------
+ - Å»ródÅa: [ASPN Cookbook](http://code.activestate.com/recipes/389023/)
+ - Autorzy: Thomas Hinkle
+ - Licencja: [MIT License](http://code.activestate.com/help/terms/)
+ - Typ: biblioteka
+ - Nota: Zmienione przez Marka StÄpniowskiego tak, żeby akceptowaÅo ciÄ
gi znaków Unicode
+
+lxml
+----
+ - Å»ródÅa: [codespeak.net](http://codespeak.net/lxml/index.html#download)
+ - Autorzy: [wielu autorów](http://codespeak.net/lxml/credits.html)
+ - Licencja: [BSD License](http://codespeak.net/lxml/index.html#license)
+ - Typ: biblioteka
+