X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=004f3aa7d83ba26f87c41f5ab6b6ffaf180e3e9d;hp=df10ba63b53b29e32f8f7ea63a4a5c4d67e3253c;hb=49c9d9b43d4f09242e86ec48806ea9ff73519e1c;hpb=11634d3b546d727a21d665af3d63e4edb04f8cbc diff --git a/docs/index.rst b/docs/index.rst index df10ba6..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 ----- @@ -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. @@ -391,7 +410,7 @@ steps .. _Twitter API: https://dev.twitter.com/docs/api/1.1 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md .. _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 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/ .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10