X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/d0deb0f3bebb42475b2b04d0ce389160cc219e44..7a12b550f4a8366c8ace2f9c55706aba7c4b17f7:/README.rst
diff --git a/README.rst b/README.rst
index 9734694a..351ca8b4 100644
--- 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 `_
* `django-piston 0.2.3rc1 `_
* `librarian 1.2 `_
@@ -14,24 +15,37 @@ Wymagania
* `Mercurial 1.3.1 `_
* `PIL 1.1.6 `_ (wymagane przez skrypt imgconv.py)
* `pngnq `_ (wymagane przez skrypt imgconv.py)
+* `zuber/django-cas-consumer `_ (wymagane do autoryzacji przez CAS)
+
+Instalacja i użycie
+===================
+#. ÅciÄ
gnij i zainstaluj `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 `_
-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 `_ na serwerze `Apache2 `_ przy pomocy zaÅÄ
czonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane sÄ
w `Dokumentacji Django `_.
-6. Uruchom serwer deweloperski::
+Wdrożenie
+=========
+#. ÅciÄ
gnij i zainstaluj `fabric `_
+#. 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 `_ na serwerze `Apache2 `_ przy pomocy zaÅÄ
czonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane sÄ
w `Dokumentacji Django `_.
+ fab production deploy