X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/47adefcf46ce7543b9b850726de5e856dab65e5d..a169ba7caa0d9d83fddcbad5ed05f536e0ca1b9e:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 3b3f03322..45c7e4e23 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ License ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) - Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska + Copyright © 2008-2019 Fundacja Nowoczesna Polska For full list of contributors see AUTHORS section at the end. @@ -23,112 +23,73 @@ License Dependencies ============ + * Python 3.4+ * All packages listed in requirements.txt - * Python libraries from lib directory - * Django applications from apps directory + * Sass>=3.2 How to deploy (development version) ============= -1. Checkout the source code from Github +1. Checkout the source code from Git and enter the directory 2. Install libraries (we recommend using pip): - pip install -r requirements.txt - -3. Setup your local configuration based on settings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff. + pip install -r requirements/requirements.txt + +3. Setup your local configuration in src/wolnelektury/localsettings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff. 4. Populate database: - ./wolnelektury/manage.py syncdb - ./wolnelektury/manage.py migrate + ./manage.py migrate + +5. Run the server + + ./manage.py runserver + -5. Import some books which are availble on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/ - -6. Run the server - - ./wolnelektury/manage.py runserver - -Full list of used open-source software -====================================== - -External --------- - -django --------- - - Source: [djangoproject.com](http://www.djangoproject.com/) - - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS) - - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE) - - Type: framework - -django-pagination ------------------ - - Source: [Google Code](http://code.google.com/p/django-pagination/) - - Authors: James Tauber , leidel@gmail.com - - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php) - - Type: library (aplikacja django) - -Django South ------------- -- Source: [aercode.org](http://south.aeracode.org/) -- Authors: Andrew Godwin , Andy McCurdy -- License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php) -- Type: library (aplikacja django) - -lxml ---------- - - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download) - - Authors: [many authors](http://codespeak.net/lxml/credits.html) - - License: [BSD License](http://codespeak.net/lxml/index.html#license) - - Type: library - -feedparser ----------- - - Source: [Google Code](http://code.google.com/p/feedparser/) - - Authors: Mark Pilgrim - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library - - -Internal (means we hacked on sources of those): ---------- - -django-compress ---------------- - - Source: [Google Code](http://code.google.com/p/django-compress/) - - Authors: Andreas Pelme - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library (Django aplication) - - django-chunks -------------- - - Source: [Google Code](http://code.google.com/p/django-chunks/) - - Authors: Clint Ecker - - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php) - - Type: library (Django aplication) - -django-newtagging ------------------ - - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/) - - Authors: Marek Stępniowski - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library (Django aplication) - - Notes: Aplication based on [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license. - -django-piston (0.2.3rc) ------------------------- - - http://bitbucket.org/jespern/django-piston/wiki/Home - -markupstring ------------- - - Source: [ASPN Cookbook](http://code.activestate.com/recipes/389023/) - - Authors: Thomas Hinkle - - License: [MIT License](http://code.activestate.com/help/terms/) - - Type: library - - Notes: Patched by Marek Stępniowski to accept Unicode strings - - +6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/ + If you use Bitbucket, you also need Mercurial to fetch books (you can install it using: pip install mercurial). + After downloading books, log into administration, go to Books and choose 'Browse' to select book file, + then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error + (just ignore it and look for other books). + +7. We provide localization of the software in following languages: Polish, Russian, German, English, Spanish, French and Lithuanian. + Translation strings are based on gettext and can be found under 'locale' dir. + There are also JavaScript files for jQuery countdown plugin (static/js/jquery.countdown-*.js). + +Bundled software +================ + +* django-chunks + in `apps/chunks` + based on [django-chunks](http://code.google.com/p/django-chunks/) + by Clint Ecker , + [New BSD License](http://www.opensource.org/licenses/bsd-license.php) +* [django-newtagging](http://www.bitbucket.org/zuber/django-newtagging/) + in `apps/newtagging` + by Marek Stępniowski , + [MIT License](http://www.opensource.org/licenses/mit-license.php), + based on [django-tagging](http://code.google.com/p/django-tagging/), also under [MIT License](http://www.opensource.org/licenses/mit-license.php) +* [jPlayer](http://jplayer.org/) + in `apps/catalogue/static/jplayer` + by Happyworm, + [MIT License](http://opensource.org/licenses/MIT) +* [Switch template tag](http://djangosnippets.org/snippets/967/) + in `apps/wolnelektury_core/templatetags/switch_tag.py` + by adurdin +* [Cropping engine for sorl-thumbnail](http://timmyomahony.com/blog/custom-cropping-engine-sorl-thumbnail/) + in `apps/picture/engine.py` + by Timmy O'Mahony +* Javascript in `apps/wolnelektury_core/static/js/contrib` + with relevant attribution and licensing + + + Authors ======= - * Marek Stępniowski - * Łukasz Rekucki \ No newline at end of file + * Łukasz Rekucki + * Radek Czajka + * Łukasz Anwajler + * Marcin Koziej + * Aleksander Łukasz + * Jan Szejko + * Mariusz Machuta