X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=35480342f3fb03e92255507ce638b6fc61a5ddc6;hp=38523bad5fed941c8e756343db02fa82030fe786;hb=95baa04465a42a304f9b96ab8e9b1e5ae695fa95;hpb=cfe34c93636af9bd5e7b1b54a6bc092f450874ec diff --git a/README.rst b/README.rst index 38523ba..3548034 100644 --- a/README.rst +++ b/README.rst @@ -50,28 +50,29 @@ Use `virtualenv`_ Troubleshooting ^^^^^^^^^^^^^^^ -If you use Linux, you might need to install some packages 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 libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev - sudo pip install rainbowstream 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 this 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 - sudo pip install rainbowstream -If installation in *the quick way* doesn't work, first try to use the *virtualenv way* before creating an issue. -In the issue, please provide following information: +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 + + Your OS + + Your Python version Usage ----- @@ -94,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).