Merge branch 'master' of stigma:platforma

[redakcja.git] / README.rst

diff --git a/README.rst b/README.rst
index 0f4e7ae..8ddf412 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,15 +1,38 @@
+Platforma Redakcyjna
+====================
+
+Opis projektu
+*************
+Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
+
+Wymagania
+*********
+* `Django 1.1 <http://djangoproject.com/>`_
+* `django-piston 0.2.3rc1 <http://bitbucket.org/jespern/django-piston/>`_
+* `librarian 1.2 <http://redmine.nowoczesnapolska.org.pl/projects/show/librarian>`_
+* `lxml 2.2.2 <http://codespeak.net/lxml/>`_
+* `Mercurial 1.3.1 <http://www.selenic.com/mercurial/>`_
+* `PIL 1.1.6 <http://www.pythonware.com/products/pil/>`_ (wymagane przez skrypt imgconv.py)
+* `pngnq <http://pngnq.sourceforge.net/>`_ (wymagane przez skrypt imgconv.py)
+* `zuber/django-cas-consumer <http://github.com/zuber/django-cas-consumer>`_ (wymagane do autoryzacji przez CAS)
+
 Instalacja
-==========
+**********
 1. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
-2. Zainstaluj wymagane biblioteki komendą::
+2. Przejdź do katalogu serwisu w konsoli
+3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
 
        pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt
 
-Zależności
-==========
+4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
+
+       ./manage.py syncdb
+
+5. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
+
+6. Uruchom serwer deweloperski::
+
+       ./manage.py runserver
+
+7. Zalecane jest serwowanie aplikacji przez `modwsgi <http://code.google.com/p/modwsgi/>`_ na serwerze `Apache2 <http://httpd.apache.org/>`_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.
 
- * `Django 1.1 <http://djangoproject.com/>`_
- * `Mercurial 1.3.1 <http://www.selenic.com/mercurial/>`_
- * `librarian 1.2 <http://redmine.nowoczesnapolska.org.pl/projects/show/librarian>`_
- * `PIL 1.1.6 <http://www.pythonware.com/products/pil/>`_ (wymagane przez skrypt imgconv.py)
- * `pngnq <http://pngnq.sourceforge.net/>`_ (wymagane przez skrypt imgconv.py)