X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7727f720c57ed94c7aaa6fb1813c4ce60e6d69f7;hp=5b524b1af9c30a5b3d56b028c0fb564611652d90;hb=3b1912ee9c8127a1f3458d3272d9e3b134bda46e;hpb=34a636ef1c8caac54bd86ab20cb7abfb25e28d33 diff --git a/README.rst b/README.rst index 5b524b1..7727f72 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,32 @@ Use `virtualenv`_ source venv/bin/activate pip install rainbowstream +Troubleshooting +^^^^^^^^^^^^^^^ + +If you use Linux, you might need to install some packages if you haven't already. +For debian-based distros, these can be installed with + +.. code:: bash + + sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-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 taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you. + +.. code:: bash + + export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future + +If installation in *the quick way* doesn't work: + +- ``sudo pip uninstall rainbowstream`` +- use the *virtualenv way* above +- `create an issue`_ and provide: + + + Your OS + + Your Python version Usage ----- @@ -83,8 +95,11 @@ 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 -to enable above feature (see `config management`_ section). +You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app +to enable above feature, +change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) +or ``IMAGE_MAX_HEIGHT`` to control max height of every image. +(see `config management`_ section). In the first time you will be asked for authorization of Rainbow Stream app at Twitter. Just click the “Authorize access” button and paste PIN @@ -167,7 +182,6 @@ steps source venv/bin/activate pip install -e . which rainbowstream # /this-directory/venv/bin/rainbowstream - pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory) # Remove ~/.rainbow_oauth if exists rainbowstream # local version of rainbowstream @@ -196,6 +210,6 @@ details .. _Create your own Twitter Application: https://apps.twitter.com/app/new .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/ -.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode +.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/ .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10