X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/154870f0416b6b387637d6035c96321410512e95..bea8ac13e42fc53e2e2151503fa2a6a467b79844:/README.md
diff --git a/README.md b/README.md
index 45c7e4e23..139cccc00 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,14 @@
+# 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
-------
@@ -20,12 +31,13 @@ License
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
+
Dependencies
============
- * Python 3.4+
+ * Python 3.5-3.7
* All packages listed in requirements.txt
- * Sass>=3.2
+
How to deploy (development version)
=============
@@ -55,34 +67,31 @@ 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).
+
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
-
Authors
=======
* Marek StÄpniowski