From 49c9d9b43d4f09242e86ec48806ea9ff73519e1c Mon Sep 17 00:00:00 2001 From: vunhat_minh Date: Fri, 22 Aug 2014 13:13:22 +0900 Subject: [PATCH] update README --- README.rst | 15 ++++++++------- docs/index.rst | 19 ++++++++++++++++--- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 38523ba..1d99ad2 100644 --- a/README.rst +++ b/README.rst @@ -56,22 +56,23 @@ 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 ----- diff --git a/docs/index.rst b/docs/index.rst index a3a8420..004f3aa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,16 +42,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 ----- -- 2.25.1