update link

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index a8c0e133244dca8e690ced715566d1bfe07756f1..adf6578c61f447a2c618f5207bdefd3ca105426a 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
     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
 \r
 Usage\r
 -----\r


@@ -61,6 +74,12 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
 \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, \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
 number to the terminal, the rainbow will start.\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
 number to the terminal, the rainbow will start.\r


@@ -212,29 +231,32 @@ Here is full list of supported command:
   + Even ``cal`` will show the calendar for current month.\r
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
 \r
   + Even ``cal`` will show the calendar for current month.\r
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
 \r

-**Config**\r
+**Config Management**\r

 \r
 -  ``theme`` will list available themes.\r
 \r
 \r
 -  ``theme`` will list available themes.\r
 \r

-  + ``theme monokai`` will apply *monokai* theme immedaitely.\r
-  + ``theme current_as_default`` will remember current theme as next time default.\r
+  + ``theme monokai`` will apply *monokai* theme immediately.\r
+  + Changed theme will be remember as the next time's default theme.\r

 \r
 -  ``config`` will list all config key.\r
 \r
 \r
 -  ``config`` will list all config key.\r
 \r

-  + ``config ASCII_ART`` will output current valut of *ASCII_ART* config key.\r
-  + ``config ASCII_ART default`` will output default valut of *ASCII_ART* config key.\r
-  + ``config ASCII_ART = False`` will set valut of *ASCII_ART* config key to *False*.\r
+  + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
+  + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.\r
+  + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.\r
+  + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.\r

 \r
 **Screening Commands**\r
 \r
 -  ``h`` will show the help.\r
 \r
 \r
 **Screening Commands**\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


@@ -271,10 +293,18 @@ 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
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r


@@ -303,6 +333,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


@@ -340,3 +391,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/#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