list fully supported and autopep8

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 5b4971ced2e8044fe6f6404bf500cfe4c438ff0b..87131f9a843131b2df0d294bf24fa704d4bcf367 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,21 +15,30 @@ This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
 Install\r
 -------\r
 \r
-You will need Python 2.7+ and pip.\r
+The quick way\r
+^^^^^^^^^^^^^\r
+\r
+You will need Python and pip (2.7.x or 3.x).\r
 \r
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
+    # Python 3 users: sudo pip3 install rainbowstream\r
+\r
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
 \r
-or try with a virtualenv\r
+Use `virtualenv`_\r
 \r
 .. code:: bash\r
 \r
-    sudo pip install virtualenv # skip if you already have virtualenv\r
     virtualenv venv\r
-    source venv/bin/activate # use the brand new virtualenv.\r
+    # Python 3 users : use -p to specify your Python 3 localtion as below\r
+    # virtualenv -p /usr/bin/python3 venv\r
+    source venv/bin/activate\r
     pip install rainbowstream\r
 \r
+\r
 Usage\r
 -----\r
 \r
@@ -96,6 +105,9 @@ Here is full list of supported command:
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
    each tweet beside the time.\r
 \r
+-  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
+   the quote will be cancelled.\r
+\r
 -  ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
 \r
 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
@@ -109,6 +121,9 @@ Here is full list of supported command:
 -  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
    OS’s image viewer.\r
 \r
+-  ``open 12`` will open url in tweet with *[id=12]* in your\r
+   OS’s default browser.\r
+\r
 **Direct Messages Commands**\r
 \r
 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
@@ -172,11 +187,11 @@ Here is full list of supported command:
 \r
 **Screening Commands**\r
 \r
--  ``theme`` will list available themes. \r
-  \r
+-  ``theme`` will list available themes.\r
+\r
   + ``theme monokai`` will apply *monokai* theme immedaitely.\r
   + ``theme current_as_default`` will remember current theme as next time default.\r
-  \r
+\r
 -  ``h`` will show the help.\r
 \r
 -  ``c`` will clear the screen.\r
@@ -215,7 +230,38 @@ Theme’s screenshot:
 \r
 For detaile information, see `theme usage and customization`_.\r
 \r
+Development\r
+-----------\r
+\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
+\r
+-  `Create your own Twitter Application`_\r
+-  Get your Twitter application’s API key and secret\r
+-  Fork github's repo\r
+-  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
+   following content\r
+\r
+   .. code:: python\r
+\r
+       # Consumer information\r
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
+\r
+-  Use pip to install in local\r
+\r
+   .. code:: bash\r
+\r
+       # cd to directory which contains setup.py\r
+       virtualenv venv # Python3 users: use -p to specify python3\r
+       source venv/bin/activate\r
+       pip install -e .\r
+       pip list | grep rainbowstream # confirm installed version\r
+       rainbowstream # local version of rainbowstream\r
 \r
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
+.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r