X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/0bd2c341a8b55f817c2e193a6c4658d52ef95961..7b36a6299b5e5e2c4e0705fa1b2965a97a76aadc:/README.md?ds=inline diff --git a/README.md b/README.md index 863593e97..13c0ed2b8 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,22 +23,21 @@ License Dependencies ============ + * Python 3.4+ * All packages listed in requirements.txt * Sass>=3.2 How to deploy (development version) ============= -1. Checkout the source code from Github and enter the directory +1. Checkout the source code from Git and enter the directory 2. Install libraries (we recommend using pip): - pip install -r requirements.txt - git submodule update --init + pip install -r requirements/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. +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: - ./manage.py syncdb ./manage.py migrate 5. Run the server @@ -60,26 +59,23 @@ Bundled software ================ * django-chunks - in `apps/chunks` + in `src/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` + in `src/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` + in `src/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` + in `src/wolnelektury/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` +* Javascript in `src/wolnelektury/static/js/contrib` with relevant attribution and licensing @@ -88,3 +84,9 @@ Authors ======= * Marek Stępniowski * Łukasz Rekucki + * Radek Czajka + * Łukasz Anwajler + * Marcin Koziej + * Aleksander Łukasz + * Jan Szejko + * Mariusz Machuta