Update README.rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index cc86e4f8f8166380a85e0c1545649af16bf1224a..5b524b1af9c30a5b3d56b028c0fb564611652d90 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -15,17 +15,28 @@ can run on Python 2.7.x and 3.x .
 \r
 \r
 Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+--------\r
 \r
-Screenshot: (click to see)\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
-   :alt: all\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+   :alt: gif\r
 \r
 Install\r
 -------\r
 \r
+Prerequisite\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
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
@@ -80,7 +91,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
@@ -93,7 +104,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
@@ -120,9 +131,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
@@ -186,3 +197,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