README.md

   1 License
   2 -------
   3
   4   ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
   5
   6     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
   7
   8     For full list of contributors see AUTHORS section at the end.
   9
  10     This program is free software: you can redistribute it and/or modify
  11     it under the terms of the GNU Affero General Public License as published by
  12     the Free Software Foundation, either version 3 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18     GNU Affero General Public License for more details.
  19
  20     You should have received a copy of the GNU Affero General Public License
  21     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 Dependencies
  24 ============
  25
  26  * All packages listed in requirements.txt
  27  * Python libraries from lib directory
  28  * Django applications from apps directory
  29
  30 How to deploy (development version)
  31 =============
  32
  33 1. Checkout the source code from Github
  34 2. Install libraries (we recommend using pip):
  35
  36     pip install -r requirements.txt
  37
  38 3. Setup your local configuration based on settings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff.
  39 4. Populate database:
  40
  41     ./wolnelektury/manage.py syncdb
  42     ./wolnelektury/manage.py migrate
  43
  44 5. Run the server
  45
  46    ./wolnelektury/manage.py runserver
  47
  48
  49 6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/
  50    If you use Bitbucket, you also need Mercurial to fetch books (you can install it using: pip install mercurial).
  51    After downloading books, log into administration, go to Books and choose 'Browse' to select book file,
  52    then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error
  53    (just ignore it and look for other books).
  54
  55
  56
  57 Full list of used open-source software
  58 ======================================
  59
  60 External
  61 --------
  62
  63 django
  64 --------
  65  - Source: [djangoproject.com](http://www.djangoproject.com/)
  66  - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
  67  - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
  68  - Type: framework
  69
  70 django-pagination
  71 -----------------
  72  - Source: [Google Code](http://code.google.com/p/django-pagination/)
  73  - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
  74  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
  75  - Type: library (aplikacja django)
  76
  77 Django South
  78 ------------
  79 - Source: [aercode.org](http://south.aeracode.org/)
  80 - Authors: Andrew Godwin <andrew@aeracode.org>, Andy McCurdy <sedrik@gmail.com>
  81 - License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php)
  82 - Type: library (aplikacja django)
  83
  84 lxml
  85 ---------
  86  - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download)
  87  - Authors: [many authors](http://codespeak.net/lxml/credits.html)
  88  - License: [BSD License](http://codespeak.net/lxml/index.html#license)
  89  - Type: library
  90
  91 feedparser
  92 ----------
  93  - Source: [Google Code](http://code.google.com/p/feedparser/)
  94  - Authors: Mark Pilgrim <pilgrim@gmail.com>
  95  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
  96  - Type: library
  97
  98
  99 Internal (means we hacked on sources of those):
 100 ---------
 101
 102 django-compress
 103 ---------------
 104  - Source: [Google Code](http://code.google.com/p/django-compress/)
 105  - Authors: Andreas Pelme <andreas.pelme@gmail.com>
 106  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
 107  - Type: library (Django aplication)
 108
 109  django-chunks
 110 -------------
 111  - Source: [Google Code](http://code.google.com/p/django-chunks/)
 112  - Authors: Clint Ecker <clintecker@gmail.com>
 113  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 114  - Type: library (Django aplication)
 115
 116 django-newtagging
 117 -----------------
 118  - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
 119  - Authors: Marek Stępniowski <marek@stepniowski.com>
 120  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
 121  - Type: library (Django aplication)
 122  - Notes: Aplication based on  [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license.
 123
 124 django-piston (0.2.3rc)
 125 ------------------------
 126  - http://bitbucket.org/jespern/django-piston/wiki/Home
 127
 128 markupstring
 129 ------------
 130  - Source: [ASPN Cookbook](http://code.activestate.com/recipes/389023/)
 131  - Authors: Thomas Hinkle
 132  - License: [MIT License](http://code.activestate.com/help/terms/)
 133  - Type: library
 134  - Notes: Patched by Marek Stępniowski <marek@stepniowski.com> to accept Unicode strings
 135
 136
 137 Authors
 138 =======
 139
 140  * Marek Stępniowski  <marek@stepniowski.com>
 141  * Łukasz Rekucki <lrekucki@gmail.com>