X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=sidebyside;f=README.rst;h=e37a81c699498909f8a1e94442a86cd93e352015;hb=e392785234900ae1270e6501f497be06e68c923c;hp=5b524b1af9c30a5b3d56b028c0fb564611652d90;hpb=34a636ef1c8caac54bd86ab20cb7abfb25e28d33;p=rainbowstream.git diff --git a/README.rst b/README.rst index 5b524b1..e37a81c 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,7 @@ Rainbow Stream Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite … and much more fun directly from terminal. -This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, +This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, can run on Python 2.7.x and 3.x . @@ -23,20 +23,6 @@ Showcase Install ------- -Prerequisite -^^^^^^^^^^^^ - -If you use Linux, you might need to install the ``python-dev`` package if you haven't already. -For debian-based distros, these can be installed with - -.. code:: bash - - sudo apt-get install python-dev - -Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with -the ``Pillow`` package installation - a dependency of this app. -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. - The quick way ^^^^^^^^^^^^^ @@ -61,6 +47,19 @@ Use `virtualenv`_ source venv/bin/activate pip install rainbowstream +Troubleshooting +^^^^^^^^^^^^^^^ + +If you use Linux, you might need to install the python-dev package if you haven't already. +For debian-based distros, these can be installed with + +.. code:: bash + + sudo apt-get install python-dev + +Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with +the ``Pillow`` package installation - a dependency of this app. +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. Usage ----- @@ -83,7 +82,7 @@ You can try it with: rainbowstream -iot # Or rainbowstream --image-on-term -You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app +You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app to enable above feature (see `config management`_ section). In the first time you will be asked for authorization of Rainbow Stream