Update index.rst

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 2235fee3f103a46589e6e772396c6ca90df8f105..efc0634f91c92f453e038e48bb3a5908504bc66c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,22 @@ can run on Python 2.7.x and 3.x .
 Install\r
 -------\r
 \r
+Prerequisite\r
+^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the ``python-dev`` and ``libsqlite3-dev`` packages if you haven't already. \r
+For debian-based distros, these can be installed with \r
+\r
+.. code:: bash\r
+\r
+    sudo apt-get install python-dev libsqlite3-dev\r
+\r
+\r
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with \r
+the ``Pillow`` package installation - a dependency of this app.\r
+If you are in this case, I recommend take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.\r
+\r
+\r
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
@@ -61,6 +77,9 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
+to enable above feature (see `config management`_ section).\r
+\r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 number to the terminal, the rainbow will start.\r
@@ -216,8 +235,8 @@ Here is full list of supported command:
 \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
+  + ``theme monokai`` will apply *monokai* theme immediately.\r
+  + Changed theme will be remember as the next time's default theme.\r
 \r
 -  ``config`` will list all config key.\r
 \r
@@ -230,6 +249,10 @@ Here is full list of supported command:
 \r
 -  ``h`` will show the help.\r
 \r
+-  ``p`` will pause the stream.\r
+\r
+-  ``r`` will unpause the stream.\r
+\r
 -  ``c`` will clear the screen.\r
 \r
 -  ``q`` will quit.\r
@@ -304,6 +327,24 @@ You can view or set a new value of every config key by ``config`` command (See *
 \r
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
+-  ``FORMAT``: display format for tweet and message.\r
+\r
+  + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
+  + ``DISPLAY``: decide how tweet will be printed.\r
+\r
+    + ``#name``: Twitter's name\r
+    + ``#nick``: Twitter's screen name\r
+    + ``#clock``: Datetime\r
+    + ``#id``: ID\r
+    + ``#fav``: favorited symbol\r
+    + ``#tweet``: Tweet's content\r
+    + ``#sender_name``: Message's sender name\r
+    + ``#sender_nick``: Message's sender screen name\r
+    + ``#to``: '>>>' symbol\r
+    + ``#recipient_name``: Message's recipient name\r
+    + ``#recipient_nick``: Message's recipient screen name\r
+\r
+\r
 Development\r
 -----------\r
 \r
@@ -341,3 +382,8 @@ steps
 .. _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
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
+.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
+\r