More cleanup, upgraded README.md

[wolnelektury.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3b3f033
--- /dev/null
+++ b/README.md
@@ -0,0 +1,134 @@
+License
+-------
+
+  ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
+    
+    Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
+    
+    For full list of contributors see AUTHORS section at the end. 
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    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
+============
+
+ * 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
+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.
+4. Populate database:
+    
+    ./wolnelektury/manage.py syncdb
+    ./wolnelektury/manage.py migrate
+    
+5. Import some books which are availble on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/
+
+6. Run the server
+
+   ./wolnelektury/manage.py runserver
+
+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 <jtauber@gmail.com>, leidel@gmail.com
+ - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
+ - Type: library (aplikacja django)
+ 
+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)
+
+lxml
+---------
+ - Żródła: [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 <pilgrim@gmail.com>
+ - 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 <andreas.pelme@gmail.com>
+ - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
+ - Type: library (Django aplication)
+ 
+ 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)
+ 
+django-newtagging
+-----------------
+ - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
+ - Authors: Marek Stępniowski <marek@stepniowski.com>
+ - 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 <marek@stepniowski.com> to accept Unicode strings
+ 
+ 
+Authors
+=======
+ 
+ * Marek Stępniowski  <marek@stepniowski.com>
+ * Łukasz Rekucki <lrekucki@gmail.com>
\ No newline at end of file