update link

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index ba3e38b8b55d1c31eaf266effd99bae1126d0529..adf6578c61f447a2c618f5207bdefd3ca105426a 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,7 +42,14 @@ Use `virtualenv`_
 Troubleshooting\r
 ^^^^^^^^^^^^^^^\r
 \r
 Troubleshooting\r
 ^^^^^^^^^^^^^^^\r
 \r

-Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
+If you use Linux, you might need to install the python-dev package 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\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
 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


@@ -67,8 +74,11 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
 \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
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
+to enable above feature, \r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) \r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(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
 \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


@@ -247,8 +257,6 @@ Here is full list of supported command:
 \r
 -  ``q`` will quit.\r
 \r
 \r
 -  ``q`` will quit.\r
 \r

-Available commands are listed in `Read The Docs`_.\r
-\r

 Theme customization\r
 ^^^^^^^^^^^^^^^^^^^\r
 \r
 Theme customization\r
 ^^^^^^^^^^^^^^^^^^^\r
 \r


@@ -285,10 +293,18 @@ Config explanation
 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
 \r
 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
 \r

+-  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
+\r
+-  ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
+\r

 -  ``THEME``: current theme.\r
 \r
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r
 -  ``THEME``: current theme.\r
 \r
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r

+-  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
+\r
+-  ``PREFIX``: display string of prompt.\r
+\r

 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r


@@ -325,8 +341,11 @@ You can view or set a new value of every config key by ``config`` command (See *
     + ``#name``: Twitter's name\r
     + ``#nick``: Twitter's screen name\r
     + ``#clock``: Datetime\r
     + ``#name``: Twitter's name\r
     + ``#nick``: Twitter's screen name\r
     + ``#clock``: Datetime\r

+    + ``#rt_count``: retweets count\r
+    + ``#fa_count``: favorites count\r

     + ``#id``: ID\r
     + ``#fav``: favorited symbol\r
     + ``#id``: ID\r
     + ``#fav``: favorited symbol\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
     + ``#tweet``: Tweet's content\r
     + ``#sender_name``: Message's sender name\r
     + ``#sender_nick``: Message's sender screen name\r


@@ -372,7 +391,7 @@ 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
 .. _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
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\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
 .. _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