Adding installation infromation in README.md

README.md

@@ -37,3 +37,46 @@ Panoramix provides:
     displayed in the UI,
     by defining which fields should show up in which dropdown and which
     aggregation and function (metrics) are made available to the user
+
+Installation
+------------
+
+Follow these few simple steps to install Panoramix
+
+```
+# Clone the github repo 
+git clone https://github.com/mistercrunch/panoramix.git
+
+# Get in that fresh new folder
+cd panoramix
+
+# You may want to create a python virtualenv
+# virtualenv env
+# source env/bin/activate
+# pip install -r requirements.txt
+
+# If you don't use a virtualenv, you'll have to sudo to install the reqs
+sudo pip install -r requirements.txt
+
+# Edit config.py, and read through the settings
+# Note that alternatively, you can create a ``local_config.py`` and put it
+# somewhere in your PYTHONPATH. The variables declared local_config.py
+# will override the ones in ``config.py``, and won't create issues when
+# you need to ``git pull`` the latest version of panoramix
+vim config.py
+
+# Create an admin account, the app will ask for username/password, ...
+# This feature is out of Flask App Builder, the framework I used to build
+# Panoramix
+fabmanager create-admin
+
+# Start the web server
+python app.py
+```
+
+After installation, you should be able to point your browser to the right
+hostname:port [http://localhost:8088](http://localhost:8088), login using
+the credential you entered while creating the admin account, and navigate to
+`Menu -> Admin -> Refresh Metadata`. This action should bring in all of 
+your datasources for Panoramix to be aware of, and they should show up in
+`Menu -> Datasources`, from where you can start playing with your data!