X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/2fa2f481732ddf6f7dcd98f549c81c5e859a89a1..756bc17550fdda2381e78ebbb9156fcab4e9cdc8:/README diff --git a/README b/README index 2f8260d3e..fa3064e1c 100644 --- a/README +++ b/README @@ -1,27 +1,93 @@ Dependencies ============ - + * [Django 1.0](http://djangoproject.com/) (application framework) * [lxml 2.0.0](http://codespeak.net/lxml/) (for importing books) + * [librarian 1.1](http://redmine.nowoczesnapolska.org.pl/projects/show/librarian) (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] + + +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. + +south +----- +- Źródła: [aercode.org](http://south.aeracode.org/) +- Autorzy: Andrew Godwin , Andy McCurdy +- Licencja: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php) +- Typ: biblioteka (aplikacja django) + +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 - -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 +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