current_buffer in unicode wrapper

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index dab891ac5ba54fb9ab99fe6c59fd246b682e859c..545002b4aef76bf1255d13f48bf33d0dfa98e9fd 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -39,6 +39,19 @@ Use `virtualenv`_
     source venv/bin/activate\r
     pip install rainbowstream\r
 \r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the python-dev package 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\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 take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.\r
 \r
 Usage\r
 -----\r
@@ -61,7 +74,7 @@ You can try it with:
 \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
+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
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
@@ -233,6 +246,10 @@ Here is full list of supported command:
 \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
@@ -279,6 +296,8 @@ You can view or set a new value of every config key by ``config`` command (See *
 \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
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
@@ -307,6 +326,24 @@ 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
+-  ``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
+    + ``#id``: ID\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
@@ -345,4 +382,7 @@ steps
 .. _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
+.. _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