X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/8325a3ee5db92b5e219b1c853d12db8534ff8bba..3aa7d1dc74ec06d89387d5735882a853b036f9c6:/README.rst

diff --git a/README.rst b/README.rst
index 0f4e7ae1..351ca8b4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,15 +1,51 @@
-Instalacja
-==========
-1. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
-2. Zainstaluj wymagane biblioteki komendą::
+====================
+Platforma Redakcyjna
+====================
 
-	pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt
+Opis projektu
+=============
+Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
 
-Zależności
-==========
+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 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)::
+
+	./project/manage.py syncdb
+
+#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
+
+#. Uruchom serwer deweloperski::
+
+	./project/manage.py runserver
+
+#. 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>`_.
+
+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ę::
+
+	fab staging deploy
+	
+ Aby wdrożyć serwis na serwer produkcyjny wpisz::
+
+	fab production deploy
 
- * `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)