Added basic deploy information to README.
[wolnelektury.git] / README
1 Dependencies
2 ============
3
4  * [Django 1.0](http://djangoproject.com/) (application framework)
5  * [lxml 2.0.0](http://codespeak.net/lxml/) (for importing books)
6  * Python libraries from lib directory
7  * Django applications from apps directory
8
9
10 How to deploy
11 =============
12
13 Just execute this commands:
14     
15     cd wolnelektury.pl
16     source setpythonpath.sh
17     cd wolnelektury
18     ./manage.py syncdb
19     ./manage.py importbooks ../books/01 ../books/02 ../books/03
20     ../setmainpage.py
21
22 [TODO]
23
24
25 Numbering
26 =========
27
28 Co numerujemy
29
30  1. W utworach wierszowanych każdy wers,
31     * przy czym powinien pokazywać się co 5 numer wersu
32     * 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.
33     * NIE numerujemy wersów utworów liczących sobie mniej niż 5 wersów 
34     * za to wskazujemy 5 i 10 wers w utworach, które z zasady liczą sobie zawsze stałą liczbę wersów – tzn. sonety)
35  2. W utworach prozą, każdy akapit (wyróżniony wcięciem akapitowym), 
36     * przy czym każdy numer akapitu powinien się wyświetlać, ułatwiając orientację w tekście 
37     * 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
38     * NIE numerujemy w dramatach: list dialogowych, nagłówków (numer aktu, sceny, osoba), «wers_cd» ani didaskaliów – tylko goły tekst.
39     * NIE numerujemy nagłówków i tytułów w opowiadaniach, nowelach, legendach i powieściach
40     * tam, gdzie akapit jest przerwany cytatem i następnie kontynuowany bez wcięcia akapitowego (akap_cd» – liczymy go razem z cytatem jako jeden numer
41  3. W dramatach numeracja zamyka się w ramach jednego aktu
42  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 
43  5. Ustaloną tradycyjnie numerację ma jedynie „Biblia” i tych ustaleń się trzymamy 
44