X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/e1a012e05dd2e7d81aa692e506f8dfc48516b08b..f959bd3a15d816089cc1c86232094411b4b0831b:/README
diff --git a/README b/README
index 8c024c0d5..bb39534eb 100644
--- a/README
+++ b/README
@@ -1,5 +1,44 @@
Dependencies
============
-
- * `Django 1.0 `_ (application framework)
- * `lxml 2.0.0 `_ (for importing books)
\ No newline at end of file
+
+ * [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 syncdb
+ ./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)
+ 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
+ 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
+