X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=40a2884e420ad4c36010d019fc441c33eb211254;hp=976461fabc74da9d613af79b29424db9f98b73ce;hb=37d1047f8c5e064eba4ef1cbae46d735568f0a9b;hpb=b13c6a0dff89f4af882c3dffd09e7502585938a3

diff --git a/README.rst b/README.rst
index 976461f..40a2884 100644
--- a/README.rst
+++ b/README.rst
@@ -10,7 +10,7 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, 
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,
 can run on Python 2.7.x and 3.x .
 
 
@@ -47,6 +47,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
 -----
@@ -70,14 +83,17 @@ 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).
+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
 number to the terminal, the rainbow will start.
 
 The interactive mode
---------------------
+^^^^^^^^^^^^^^^^^^^^
 
 While your personal stream is continued, you are also ready to tweet,
 search, reply, retweet… directly from console. Simply type “h” and hit
@@ -90,7 +106,7 @@ suggestion. Input history from previous run is available as well.
 Available commands are listed in `Read The Docs`_.
 
 Theme customization
--------------------
+^^^^^^^^^^^^^^^^^^^
 
 Rainbow Stream is shipped with some default themes.
 You can either change theme by ``theme`` command or create your favorite one.
@@ -117,9 +133,9 @@ Theme’s screenshot:
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
    :alt: larapaste
 
-
 For detaile information, see `theme usage and customization`_.
 
+
 Bug and feature requests
 ------------------------
 
@@ -182,4 +198,6 @@ details
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
 .. _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
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10