autopep8

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 461a2e1346c6366a7ebade55bf0c1eee76ab9839..e37a81c699498909f8a1e94442a86cd93e352015 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -10,7 +10,7 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
 can run on Python 2.7.x and 3.x .\r
 \r
 \r
@@ -23,14 +23,6 @@ Showcase
 Install\r
 -------\r
 \r
-Requirements\r
-^^^^^^^^^^^^\r
-\r
-If you use Linux, you might need to install the ``python-dev`` and \r
-``libsqlite3-dev`` packages if you haven't already. For debian-based distros, \r
-these can be installed with ``sudo apt-get install python-dev libsqlite3-dev``.\r
-\r
-\r
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
@@ -55,6 +47,19 @@ Use `virtualenv`_
     source venv/bin/activate\r
     pip install rainbowstream\r
 \r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\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
 Usage\r
 -----\r
@@ -77,7 +82,7 @@ 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
+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
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
@@ -85,7 +90,7 @@ app at Twitter. Just click the “Authorize access” button and paste PIN
 number to the terminal, the rainbow will start.\r
 \r
 The interactive mode\r
---------------------\r
+^^^^^^^^^^^^^^^^^^^^\r
 \r
 While your personal stream is continued, you are also ready to tweet,\r
 search, reply, retweet… directly from console. Simply type “h” and hit\r
@@ -98,7 +103,7 @@ suggestion. Input history from previous run is available as well.
 Available commands are listed in `Read The Docs`_.\r
 \r
 Theme customization\r
--------------------\r
+^^^^^^^^^^^^^^^^^^^\r
 \r
 Rainbow Stream is shipped with some default themes.\r
 You can either change theme by ``theme`` command or create your favorite one.\r
@@ -125,9 +130,9 @@ Theme’s screenshot:
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
    :alt: larapaste\r
 \r
-\r
 For detaile information, see `theme usage and customization`_.\r
 \r
+\r
 Bug and feature requests\r
 ------------------------\r
 \r
@@ -191,3 +196,5 @@ details
 .. _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
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r