From 5d0e17972743fb373a1cf4a234dbab9dbe13502f Mon Sep 17 00:00:00 2001
From: Maciej Tronowski <mtro@man.poznan.pl>
Date: Thu, 2 Apr 2015 14:51:51 +0200
Subject: [PATCH] add README file

---
 README.md |   63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6971ac6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# QCG Portal
+
+Portal providing access to PLGrid infrastructure via [QosCosGrid](http://www.qoscosgrid.org) services.
+
+
+# Installation
+
+There are two sets of configuration files: one for development and one for production usage.
+
+Development settings use django development server with sqlite database. 
+Production settings use uwsgi server with shipped configuration file and postgres database.
+  
+Production configuration should be individually adapted therefore it isn't covered in this short description.
+Contact us if you have questions or need any help with it.
+
+
+## Requirements
+
+### Non python
+
+* [Globus toolkit](http://toolkit.globus.org/toolkit/)
+
+### Python
+
+Python version: 2.7. 
+
+All required python packages are listed in requirements.txt or requirements_dev.txt files 
+for production or development usage respectively.
+
+All packages could be automatically installed using pip (if there are new positions add to file, run this command again):
+
+    pip install -r requirements_dev.txt
+
+One additional package not listed in requirements file that is needed for production is *uwsgi*.
+
+
+## Deployment
+
+Key functions of the portal require access to PLGrid infrastructure. Access authorization is based on user's proxy. 
+In development this proxy is loaded from file pointed by `settings.PROXY_FILE` 
+(in production this proxy is given by OpenID service). 
+This proxy file could be obtained by logging into *qcg.man.poznan.pl* and running:
+
+    grid-proxy-init -valid 2400:00 -out proxy
+
+This command creates new proxy valid for 100 days and saves it to file *proxy*.
+
+
+1. Create database tables (this should be also run after updates which add new migrations):
+
+        manage.py migrate
+
+2. Create user account (username should be same as user for which the proxy was generated):
+
+        manage.py createsuperuser
+
+3. Run server process:
+
+        manage.py runserver
+
+# Contact
+
+[qcg@plgrid.pl](mailto:qcg@plgrid.pl)
-- 
1.7.9.5