X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7727f720c57ed94c7aaa6fb1813c4ce60e6d69f7;hp=40a2884e420ad4c36010d019fc441c33eb211254;hb=3ad5161581aff9d5b717b797627827af2ea4bac7;hpb=98f3deaa2df943c3c7e9f28bedd1a28c3347982e;ds=sidebyside diff --git a/README.rst b/README.rst index 40a2884..7727f72 100644 --- a/README.rst +++ b/README.rst @@ -50,16 +50,29 @@ Use `virtualenv`_ Troubleshooting ^^^^^^^^^^^^^^^ -If you use Linux, you might need to install the python-dev package if you haven't already. +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 + 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 take a look at `Issue #10`_ and let me know if the workaround doesn't work for you. +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 ----- @@ -82,9 +95,9 @@ 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, -change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) +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). @@ -169,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