X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=6ec76feb9c9a243b876ab8fd9857a7c3a9cc5ec1;hp=d97214f6417f328895a2bd746416f0a82dd4235e;hb=a8c5fce4b567697790144ec15546ce68e5469963;hpb=090327d8c0d1233738bb0a9c5c47bf1b49f2ee54;ds=sidebyside

diff --git a/README.rst b/README.rst
index d97214f..6ec76fe 100644
--- a/README.rst
+++ b/README.rst
@@ -10,31 +10,47 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, 
+can run on Python 2.7.x and 3.x .
+
 
 Showcase
 ----------
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
 
+Screenshot: (click to see)
 
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png
+   :alt: all
+   
 Install
 -------
 
-You will need Python 2.7+ and pip.
+The quick way
+^^^^^^^^^^^^^
+
+You will need Python and pip (2.7.x or 3.x).
 
 .. code:: bash
 
     sudo pip install rainbowstream
+    # Python 3 users: sudo pip3 install rainbowstream
+
+
+The recommended way
+^^^^^^^^^^^^^^^^^^^
 
-or try with a virtualenv
+Use `virtualenv`_
 
 .. code:: bash
 
-    sudo pip install virtualenv # skip if you already have virtualenv
     virtualenv venv
-    source venv/bin/activate # use the brand new virtualenv.
+    # Python 3 users : use -p to specify your Python 3 localtion as below
+    # virtualenv -p /usr/bin/python3 venv
+    source venv/bin/activate
     pip install rainbowstream
 
+
 Usage
 -----
 
@@ -110,6 +126,38 @@ Bug and feature requests
 Found a bug or a feature request ?
 Please `create an issue`_ or contact me at `@dtvd88`_
 
+Development
+-----------
+
+If you want to build a runnable version yourself, follow these simple
+steps
+
+-  `Create your own Twitter Application`_
+-  Get your Twitter application’s API key and secret
+-  Fork this repo and clone in your system.
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with
+   following content
+
+   .. code:: python
+
+       # Consumer information
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
+
+-  Use pip to install in local
+
+   .. code:: bash
+
+       # cd to directory which contains setup.py (cloned directory)
+       virtualenv venv # Python3 users: use -p to specify python3
+       source venv/bin/activate
+       pip install -e .
+       which rainbowstream # /this-directory/venv/bin/rainbowstream
+       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+       # Remove ~/.rainbow_oauth if exists
+       rainbowstream # local version of rainbowstream
+
+
 Contributing
 ------------
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
@@ -131,3 +179,6 @@ details
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new
+.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/