X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/67df302167539474edd02b57c2e8bd30349d7625..66cc5b69e597087e8ab5b52f8e8aff1d942d6674:/README.md diff --git a/README.md b/README.md index 725dc7c2d..139cccc00 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ +# Wolne Lektury + +![Wolne Lektury](src/wolnelektury/static/img/logo-bez.png) + + +Wolne Lektury is a free internet library maintained by Modern Poland Foundation. + +It's a service based on [Django](https://www.djangoproject.com/), using +[Librarian](https://git.mdrn.pl/librarian.git) to publish books in various formats. + + 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. @@ -20,30 +31,30 @@ License You should have received a copy of the GNU Affero General Public License along with this program. If not, see . + Dependencies ============ + * Python 3.5-3.7 * All packages listed in requirements.txt - * Python libraries from lib directory - * Django applications from apps directory + 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 - ./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 +67,38 @@ 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 `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 `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 `src/catalogue/static/jplayer` + by Happyworm, + [MIT License](http://opensource.org/licenses/MIT) +* [Switch template tag](http://djangosnippets.org/snippets/967/) + in `src/wolnelektury/templatetags/switch_tag.py` + by adurdin +* Javascript in `src/wolnelektury/static/js/contrib` + with relevant attribution and licensing + + Authors ======= - * Marek Stępniowski * Łukasz Rekucki + * Radek Czajka + * Łukasz Anwajler + * Marcin Koziej + * Aleksander Łukasz + * Jan Szejko + * Mariusz Machuta