From c299503e493eaed2aee7b7c0ca26767dc1530ec9 Mon Sep 17 00:00:00 2001
From: Gal Margalit <gal.margalit@alcatel-lucent.com>
Date: Mon, 10 Aug 2015 14:13:47 +0000
Subject: [PATCH] mistral-dashboard documentation

* Added PyCharm debug documentation

Partially implements blueprint: mistral-documentation

Change-Id: Ifdf5466d5214e85e97cb491c79742b8c3b35e071
---
 README.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.rst b/README.rst
index 5ca1adb..25d9e27 100644
--- a/README.rst
+++ b/README.rst
@@ -53,4 +53,17 @@ or run the development server (in case you have decided to use local horizon)::
     $ cd ../horizon/
     $ tox -evenv -- python manage.py runserver
 
+Debug Instructions
+==================
+**Pycharm**
 
+Set PyCharm debug settings:
+
+  1. Enter debug configurations menu
+  2. Create a new Django Server configuration
+  3. Enter some port so it won't run on the default (for example - port: 4000)
+  4. On the same window click on Environment variables
+     a. Make sure you have PYTHONUNBUFFERED set as 1
+     b. Create a new pair - DJANGO_SETTINGS_MODULE : openstack_dashboard.settings
+
+You should now be able to debug and run the project using PyCharm.
\ No newline at end of file