X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=377d21f5df33840a364d2205329ff43eafe3f058;hp=2235fee3f103a46589e6e772396c6ca90df8f105;hb=779b06408936e365b959bcf5365d3b051fa628e7;hpb=42143fbea10357d02f1780ecae9a213897c04101

diff --git a/docs/index.rst b/docs/index.rst
index 2235fee..377d21f 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,6 +74,9 @@ 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).
+
 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
 number to the terminal, the rainbow will start.
@@ -216,8 +232,8 @@ Here is full list of supported command:
 
 -  ``theme`` will list available themes.
 
-  + ``theme monokai`` will apply *monokai* theme immedaitely.
-  + ``theme current_as_default`` will remember current theme as next time default.
+  + ``theme monokai`` will apply *monokai* theme immediately.
+  + Changed theme will be remember as the next time's default theme.
 
 -  ``config`` will list all config key.
 
@@ -230,12 +246,14 @@ Here is full list of supported command:
 
 -  ``h`` will show the help.
 
+-  ``p`` will pause the stream.
+
+-  ``r`` will unpause the stream.
+
 -  ``c`` will clear the screen.
 
 -  ``q`` will quit.
 
-Available commands are listed in `Read The Docs`_.
-
 Theme customization
 ^^^^^^^^^^^^^^^^^^^
 
@@ -276,6 +294,8 @@ You can view or set a new value of every config key by ``config`` command (See *
 
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
 
+-  ``HIDE_PROMPT``: Hide prompt after receiving a tweet or not.
+
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
 
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
@@ -304,6 +324,27 @@ You can view or set a new value of every config key by ``config`` command (See *
 
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.
 
+-  ``FORMAT``: display format for tweet and message.
+
+  + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.
+  + ``DISPLAY``: decide how tweet will be printed.
+
+    + ``#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
+    + ``#to``: '>>>' symbol
+    + ``#recipient_name``: Message's recipient name
+    + ``#recipient_nick``: Message's recipient screen name
+
+
 Development
 -----------
 
@@ -341,3 +382,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
+.. _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
+