Translatable chunks.
[wolnelektury.git] / README.md
index cfc289a..9b4f4a5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -30,20 +30,21 @@ Dependencies
 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 syncdb
+    ./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/
@@ -52,7 +53,9 @@ How to deploy (development version)
    then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error
    (just ignore it and look for other books).
    
-
+7. We provide localization of the software in following languages: Polish, Russian, German, English, Spanish, French and Lithuanian.
+   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
 ======================================
@@ -72,18 +75,26 @@ django-pagination
  - Source: [Google Code](http://code.google.com/p/django-pagination/)
  - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
- - Type: library (aplikacja django)
+ - Type: library (django application)
+
+django-rosetta
+-----------------
+ - Source: [Google Code](http://code.google.com/p/django-rosetta/)
+ - Authors: James Tauber <jtauber@gmail.com>, 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 <andrew@aeracode.org>, Andy McCurdy <sedrik@gmail.com>
 - License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php)
-- Type: library (aplikacja django)
+- Type: library (django application)
 
 lxml
 ---------
- - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download)
+ - 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
@@ -99,19 +110,12 @@ feedparser
 Internal (means we hacked on sources of those): 
 ---------
  
-django-compress
----------------
- - Source: [Google Code](http://code.google.com/p/django-compress/)
- - Authors: Andreas Pelme <andreas.pelme@gmail.com>
- - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
- - Type: library (Django aplication)
- django-chunks
+django-chunks
 -------------
  - Source: [Google Code](http://code.google.com/p/django-chunks/)
  - Authors: Clint Ecker <clintecker@gmail.com>
  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
- - Type: library (Django aplication)
+ - Type: library (Django application)
  
 django-newtagging
 -----------------
@@ -121,19 +125,7 @@ django-newtagging
  - 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 <marek@stepniowski.com> to accept Unicode strings
 Authors
 =======