X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=d32f5102a241bc86e600a4c1d0190310fc914a30;hp=efc0634f91c92f453e038e48bb3a5908504bc66c;hb=b89ece54202908028fcf174b190fda321db63394;hpb=bdc155b7bab41e6eb57cfd13b9be16d8d9a2768f

diff --git a/docs/index.rst b/docs/index.rst
index efc0634..d32f510 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,22 +16,6 @@ can run on Python 2.7.x and 3.x .
 Install
 -------
 
-Prerequisite
-^^^^^^^^^^^^
-
-If you use Linux, you might need to install the ``python-dev`` and ``libsqlite3-dev`` packages if you haven't already. 
-For debian-based distros, these can be installed with 
-
-.. code:: bash
-
-    sudo apt-get install python-dev libsqlite3-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.
-
-
 The quick way
 ^^^^^^^^^^^^^
 
@@ -55,6 +39,32 @@ Use `virtualenv`_
     source venv/bin/activate
     pip install rainbowstream
 
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+If you use Linux, you might need to install some packages if you haven't already. 
+For debian-based distros, these can be installed with
+
+.. code:: bash
+
+    sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-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 taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you.
+
+.. code:: bash
+
+    export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future
+
+If installation in *the quick way* doesn't work:
+
+-  ``sudo pip uninstall rainbowstream``
+-  use the *virtualenv way* above
+-  `create an issue`_ and provide:
+
+  + Your OS
+  + Your Python version
 
 Usage
 -----
@@ -77,8 +87,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
@@ -257,8 +270,6 @@ Here is full list of supported command:
 
 -  ``q`` will quit.
 
-Available commands are listed in `Read The Docs`_.
-
 Theme customization
 ^^^^^^^^^^^^^^^^^^^
 
@@ -295,16 +306,30 @@ 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.
 
 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
 
+-  ``QUOTE_FORMAT``: format when quote a tweet
+
+    + ``#comment``: Your own comment about the tweet
+    + ``#owner``: owner's username with '@'
+    + ``#tweet``: original tweet
+
 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
 
 -  ``TREND_MAX``: default trends to display on 'trend' command.
@@ -335,8 +360,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
@@ -382,7 +410,7 @@ 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