Merge pull request #38 from frasertweedale/fix/no-gcc
[rainbowstream.git] / README.rst
index 02c9f423f14290ccbb61305f9fa64022ac9dafd6..40a2884e420ad4c36010d019fc441c33eb211254 100644 (file)
@@ -50,7 +50,14 @@ Use `virtualenv`_
 Troubleshooting\r
 ^^^^^^^^^^^^^^^\r
 \r
-Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
+If you use Linux, you might need to install the python-dev package if you haven't already. \r
+For debian-based distros, these can be installed with\r
+\r
+.. code:: bash\r
+\r
+    sudo apt-get install python-dev\r
+\r
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
 the ``Pillow`` package installation - a dependency of this app.\r
 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.\r
 \r
@@ -75,8 +82,11 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
-You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
-to enable above feature (see `config management`_ section).\r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
+to enable above feature, \r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) \r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(see `config management`_ section).\r
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
@@ -188,6 +198,6 @@ details
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
-.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r