Process to Thread, Goodbye SQLAlchemy

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 6ec76feb9c9a243b876ab8fd9857a7c3a9cc5ec1..f2dd4eb76255c2fb5df25b7e85b0dcfad071200c 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
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+   :alt: gif\r
 \r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
-   :alt: all\r
-   \r
 Install\r
 -------\r
 \r
+Prerequisite\r
+^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the ``python-dev`` and ``libsqlite3-dev`` packages 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 libsqlite3-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
@@ -72,12 +83,15 @@ 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
+\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
 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
@@ -90,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
@@ -117,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
@@ -182,3 +196,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
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r