X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=adf6578c61f447a2c618f5207bdefd3ca105426a;hp=a9a3e00e509c7a6ffff9deee536b00fafd8edd7e;hb=98f3deaa2df943c3c7e9f28bedd1a28c3347982e;hpb=d6cc4c67f3bf71ea6a434fdb438d23a08ff814e9

diff --git a/docs/index.rst b/docs/index.rst
index a9a3e00..adf6578 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -39,6 +39,19 @@ Use `virtualenv`_
     source venv/bin/activate
     pip install rainbowstream
 
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+If you use Linux, you might need to install the python-dev package if you haven't already.
+For debian-based distros, these can be installed with
+
+.. code:: bash
+
+    sudo apt-get install python-dev
+
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
+the ``Pillow`` package installation - a dependency of this app.
+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.
 
 Usage
 -----
@@ -61,8 +74,11 @@ You can try it with:
 
     rainbowstream -iot # Or rainbowstream --image-on-term
 
-You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
-to enable above feature (see `config management`_ section).
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app 
+to enable above feature, 
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) 
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.
+(see `config management`_ section).
 
 In the first time you will be asked for authorization of Rainbow Stream
 app at Twitter. Just click the “Authorize access” button and paste PIN
@@ -241,8 +257,6 @@ Here is full list of supported command:
 
 -  ``q`` will quit.
 
-Available commands are listed in `Read The Docs`_.
-
 Theme customization
 ^^^^^^^^^^^^^^^^^^^
 
@@ -279,10 +293,18 @@ Config explanation
 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
 
+-  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.
+
+-  ``IMAGE_ON_TERM``: display tweet's image directly on terminal.
+
 -  ``THEME``: current theme.
 
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
 
+-  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.
+
+-  ``PREFIX``: display string of prompt.
+
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
 
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
@@ -319,8 +341,11 @@ You can view or set a new value of every config key by ``config`` command (See *
     + ``#name``: Twitter's name
     + ``#nick``: Twitter's screen name
     + ``#clock``: Datetime
+    + ``#rt_count``: retweets count
+    + ``#fa_count``: favorites count
     + ``#id``: ID
     + ``#fav``: favorited symbol
+    + ``#fav``: favorited symbol
     + ``#tweet``: Tweet's content
     + ``#sender_name``: Message's sender name
     + ``#sender_nick``: Message's sender screen name
@@ -366,7 +391,8 @@ steps
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
-.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation
 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime
-
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10