X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=docs%2Findex.rst;h=545002b4aef76bf1255d13f48bf33d0dfa98e9fd;hb=2a857ef419adf7fa8e7866189df76ee111166a20;hp=f4ed3ae3d5056a734f9ae2999799c80131b93e7a;hpb=7746aa9612b0148cc8a9eb3a9fc9ac16372deded;p=rainbowstream.git

diff --git a/docs/index.rst b/docs/index.rst
index f4ed3ae..545002b 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,7 +74,7 @@ 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 
+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
@@ -233,6 +246,10 @@ 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.
@@ -279,6 +296,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.
@@ -309,20 +328,20 @@ You can view or set a new value of every config key by ``config`` command (See *
 
 -  ``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
-    + `#id`: ID
-    + `#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
+  + ``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
+    + ``#id``: ID
+    + ``#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
@@ -364,5 +383,6 @@ steps
 .. _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