minor fix
[wolnelektury.git] / 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. Import some books which are availble on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/
45
46 6. Run the server
47
48    ./wolnelektury/manage.py runserver
49
50 Full list of used open-source software
51 ======================================
52
53 External
54 --------
55
56 django
57 --------
58  - Source: [djangoproject.com](http://www.djangoproject.com/)
59  - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
60  - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
61  - Type: framework
62
63 django-pagination
64 -----------------
65  - Source: [Google Code](http://code.google.com/p/django-pagination/)
66  - Authors: James Tauber <jtauber@gmail.com>, leidel@gmail.com
67  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
68  - Type: library (aplikacja django)
69  
70 Django South
71 ------------
72 - Source: [aercode.org](http://south.aeracode.org/)
73 - Authors: Andrew Godwin <andrew@aeracode.org>, Andy McCurdy <sedrik@gmail.com>
74 - License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php)
75 - Type: library (aplikacja django)
76
77 lxml
78 ---------
79  - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download)
80  - Authors: [many authors](http://codespeak.net/lxml/credits.html)
81  - License: [BSD License](http://codespeak.net/lxml/index.html#license)
82  - Type: library
83  
84 feedparser
85 ----------
86  - Source: [Google Code](http://code.google.com/p/feedparser/)
87  - Authors: Mark Pilgrim <pilgrim@gmail.com>
88  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
89  - Type: library
90
91
92 Internal (means we hacked on sources of those): 
93 ---------
94  
95 django-compress
96 ---------------
97  - Source: [Google Code](http://code.google.com/p/django-compress/)
98  - Authors: Andreas Pelme <andreas.pelme@gmail.com>
99  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
100  - Type: library (Django aplication)
101  
102  django-chunks
103 -------------
104  - Source: [Google Code](http://code.google.com/p/django-chunks/)
105  - Authors: Clint Ecker <clintecker@gmail.com>
106  - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
107  - Type: library (Django aplication)
108  
109 django-newtagging
110 -----------------
111  - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
112  - Authors: Marek Stępniowski <marek@stepniowski.com>
113  - License: [MIT License](http://www.opensource.org/licenses/mit-license.php)
114  - Type: library (Django aplication)
115  - Notes: Aplication based on  [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license.
116  
117 django-piston (0.2.3rc)
118 ------------------------
119  - http://bitbucket.org/jespern/django-piston/wiki/Home
120
121 markupstring
122 ------------
123  - Source: [ASPN Cookbook](http://code.activestate.com/recipes/389023/)
124  - Authors: Thomas Hinkle
125  - License: [MIT License](http://code.activestate.com/help/terms/)
126  - Type: library
127  - Notes: Patched by Marek Stępniowski <marek@stepniowski.com> to accept Unicode strings
128  
129  
130 Authors
131 =======
132  
133  * Marek Stępniowski  <marek@stepniowski.com>
134  * Łukasz Rekucki <lrekucki@gmail.com>