Poprawienie nazwy zmiennej "availble_themes" -> "available_themes".

[redakcja.git] / README.rst

diff --git a/README.rst b/README.rst
index 9734694..351ca8b 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,13 @@
+====================
 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>`_
@@ -14,24 +15,37 @@ Wymagania
 * `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 i użycie
+===================
+#. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
+#. Przejdź do katalogu serwisu w konsoli
+#. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
+
+       pip install -r requirements.txt
+
+#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
 
-Instalacja
-**********
-1. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
-2. Przejdź do katalogu serwisu w konsoli
-3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
+       ./project/manage.py syncdb
 
-       pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt
+#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
 
-4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
+#. Uruchom serwer deweloperski::
 
-       ./manage.py syncdb
+       ./project/manage.py runserver
 
-5. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
+#. 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>`_.
 
-6. Uruchom serwer deweloperski::
+Wdrożenie
+=========
+#. Ściągnij i zainstaluj `fabric <http://docs.fabfile.org/>`_
+#. Przejdź do katalogu serwisu w konsoli
+#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę::
 
-       ./manage.py runserver
+       fab staging deploy
+       
+ Aby wdrożyć serwis na serwer produkcyjny wpisz::
 
-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>`_.
+       fab production deploy