X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=d32f5102a241bc86e600a4c1d0190310fc914a30;hp=adf6578c61f447a2c618f5207bdefd3ca105426a;hb=b89ece54202908028fcf174b190fda321db63394;hpb=98f3deaa2df943c3c7e9f28bedd1a28c3347982e diff --git a/docs/index.rst b/docs/index.rst index adf6578..d32f510 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 ----- @@ -311,6 +324,12 @@ You can view or set a new value of every config key by ``config`` command (See * - ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command. +- ``QUOTE_FORMAT``: format when quote a tweet + + + ``#comment``: Your own comment about the tweet + + ``#owner``: owner's username with '@' + + ``#tweet``: original tweet + - ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command. - ``TREND_MAX``: default trends to display on 'trend' command.