Update README.rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index e37a81c699498909f8a1e94442a86cd93e352015..38523bad5fed941c8e756343db02fa82030fe786 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -50,16 +50,28 @@ Use `virtualenv`_
 Troubleshooting\r
 ^^^^^^^^^^^^^^^\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
+If you use Linux, you might need to install some packages if you haven't already. \r

 For debian-based distros, these can be installed with\r
 \r
 .. code:: bash\r
 \r
 For debian-based distros, these can be installed with\r
 \r
 .. code:: bash\r
 \r

-    sudo apt-get install python-dev\r
+    sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
+    sudo pip install rainbowstream\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
 \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
+If you are in this case, I recommend take a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
+\r
+.. code:: bash\r
+\r
+    export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
+    sudo pip install rainbowstream\r
+\r
+If installation in *the quick way* doesn't work, first try to use the *virtualenv way* before creating an issue.\r
+In the issue, please provide following information:\r
+\r
+-  Your OS\r
+-  Your Python version\r

 \r
 Usage\r
 -----\r
 \r
 Usage\r
 -----\r


@@ -82,8 +94,11 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
 \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
 \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


@@ -195,6 +210,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
 .. _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
 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r