update README
[rainbowstream.git] / docs / index.rst
index dab891a..d32f510 100644 (file)
@@ -39,6 +39,32 @@ Use `virtualenv`_
     source venv/bin/activate\r
     pip install rainbowstream\r
 \r
     source venv/bin/activate\r
     pip install rainbowstream\r
 \r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install some packages if you haven't already. \r
+For debian-based distros, these can be installed with\r
+\r
+.. code:: bash\r
+\r
+    sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
+\r
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
+the ``Pillow`` package installation - a dependency of this app.\r
+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.\r
+\r
+.. code:: bash\r
+\r
+    export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
+\r
+If installation in *the quick way* doesn't work:\r
+\r
+-  ``sudo pip uninstall rainbowstream``\r
+-  use the *virtualenv way* above\r
+-  `create an issue`_ and provide:\r
+\r
+  + Your OS\r
+  + Your Python version\r
 \r
 Usage\r
 -----\r
 \r
 Usage\r
 -----\r
@@ -62,7 +88,10 @@ You can try it with:
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
-to enable above feature (see `config management`_ section).\r
+to enable above feature, \r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) \r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(see `config management`_ section).\r
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
@@ -233,12 +262,14 @@ Here is full list of supported command:
 \r
 -  ``h`` will show the help.\r
 \r
 \r
 -  ``h`` will show the help.\r
 \r
+-  ``p`` will pause the stream.\r
+\r
+-  ``r`` will unpause the stream.\r
+\r
 -  ``c`` will clear the screen.\r
 \r
 -  ``q`` will quit.\r
 \r
 -  ``c`` will clear the screen.\r
 \r
 -  ``q`` will quit.\r
 \r
-Available commands are listed in `Read The Docs`_.\r
-\r
 Theme customization\r
 ^^^^^^^^^^^^^^^^^^^\r
 \r
 Theme customization\r
 ^^^^^^^^^^^^^^^^^^^\r
 \r
@@ -275,16 +306,30 @@ Config explanation
 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
 \r
 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
 \r
+-  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
+\r
+-  ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
+\r
 -  ``THEME``: current theme.\r
 \r
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r
 -  ``THEME``: current theme.\r
 \r
 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r
+-  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
+\r
+-  ``PREFIX``: display string of prompt.\r
+\r
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
 \r
 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
 \r
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
 \r
 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
 \r
+-  ``QUOTE_FORMAT``: format when quote a tweet\r
+\r
+    + ``#comment``: Your own comment about the tweet\r
+    + ``#owner``: owner's username with '@'\r
+    + ``#tweet``: original tweet\r
+\r
 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
 \r
 -  ``TREND_MAX``: default trends to display on 'trend' command.\r
 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
 \r
 -  ``TREND_MAX``: default trends to display on 'trend' command.\r
@@ -307,6 +352,27 @@ You can view or set a new value of every config key by ``config`` command (See *
 \r
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
 \r
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
+-  ``FORMAT``: display format for tweet and message.\r
+\r
+  + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
+  + ``DISPLAY``: decide how tweet will be printed.\r
+\r
+    + ``#name``: Twitter's name\r
+    + ``#nick``: Twitter's screen name\r
+    + ``#clock``: Datetime\r
+    + ``#rt_count``: retweets count\r
+    + ``#fa_count``: favorites count\r
+    + ``#id``: ID\r
+    + ``#fav``: favorited symbol\r
+    + ``#fav``: favorited symbol\r
+    + ``#tweet``: Tweet's content\r
+    + ``#sender_name``: Message's sender name\r
+    + ``#sender_nick``: Message's sender screen name\r
+    + ``#to``: '>>>' symbol\r
+    + ``#recipient_name``: Message's recipient name\r
+    + ``#recipient_nick``: Message's recipient screen name\r
+\r
+\r
 Development\r
 -----------\r
 \r
 Development\r
 -----------\r
 \r
@@ -344,5 +410,8 @@ steps
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
-.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
+.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
 \r
 \r