Housekeeping.

[wolnelektury.git] / README.md

diff --git a/README.md b/README.md
index 5b39ff9..139cccc 100644 (file)
--- 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 <fundacja@nowoczesnapolska.org.pl>
+    Copyright © 2008-2019 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
     
     For full list of contributors see AUTHORS section at the end. 
 
@@ -20,23 +31,23 @@ License
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
     
+
 Dependencies
 ============
 
- * Python 2.7
+ * Python 3.5-3.7
  * 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/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.
+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 migrate
@@ -56,35 +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).
 
+
 Bundled software
 ================
 
 * django-chunks
-  in `apps/chunks`
+  in `src/chunks`
   based on [django-chunks](http://code.google.com/p/django-chunks/)
   by Clint Ecker <clintecker@gmail.com>,
   [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 <marek@stepniowski.com>,
   [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  <marek@stepniowski.com>
  * Łukasz Rekucki <lrekucki@gmail.com>
+ * Radek Czajka
+ * Łukasz Anwajler
+ * Marcin Koziej
+ * Aleksander Łukasz
+ * Jan Szejko
+ * Mariusz Machuta