X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/24759d1f7ba57ec825031d49a0684c6f0242c6c6..3a2793b0c0d892fa497007c3466943de3de5a752:/README.md diff --git a/README.md b/README.md index 725dc7c2d..340ae0477 100644 --- a/README.md +++ b/README.md @@ -23,27 +23,27 @@ License Dependencies ============ + * Python 2.7 * 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 Github and enter the directory 2. Install libraries (we recommend using pip): pip install -r requirements.txt - + git submodule update --init + 3. Setup your local configuration based on settings.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 - ./wolnelektury/manage.py runserver + ./manage.py runserver 6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/ @@ -56,96 +56,35 @@ How to deploy (development version) 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). -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 (django application) - -django-rosetta ------------------ - - Source: [Google Code](http://code.google.com/p/django-rosetta/) - - Authors: James Tauber , leidel@gmail.com - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library (django application) - - -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 (django application) - -lxml ---------- - - Source: [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 application) - - 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 application) - -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 - - +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