X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=e37a81c699498909f8a1e94442a86cd93e352015;hp=461a2e1346c6366a7ebade55bf0c1eee76ab9839;hb=2050bc12ebd6aa3dda869225c1d88289ab66b212;hpb=60a59e8b604c770af36036a869ae67a90b646486 diff --git a/README.rst b/README.rst index 461a2e1..e37a81c 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,7 @@ Rainbow Stream Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite … and much more fun directly from terminal. -This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, +This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, can run on Python 2.7.x and 3.x . @@ -23,14 +23,6 @@ Showcase Install ------- -Requirements -^^^^^^^^^^^^ - -If you use Linux, you might need to install the ``python-dev`` and -``libsqlite3-dev`` packages if you haven't already. For debian-based distros, -these can be installed with ``sudo apt-get install python-dev libsqlite3-dev``. - - The quick way ^^^^^^^^^^^^^ @@ -55,6 +47,19 @@ Use `virtualenv`_ source venv/bin/activate pip install rainbowstream +Troubleshooting +^^^^^^^^^^^^^^^ + +If you use Linux, you might need to install the python-dev package if you haven't already. +For debian-based distros, these can be installed with + +.. code:: bash + + sudo apt-get install python-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. Usage ----- @@ -77,7 +82,7 @@ You can try it with: rainbowstream -iot # Or rainbowstream --image-on-term -You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app +You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app to enable above feature (see `config management`_ section). In the first time you will be asked for authorization of Rainbow Stream @@ -85,7 +90,7 @@ app at Twitter. Just click the “Authorize access” button and paste PIN number to the terminal, the rainbow will start. The interactive mode --------------------- +^^^^^^^^^^^^^^^^^^^^ While your personal stream is continued, you are also ready to tweet, search, reply, retweet… directly from console. Simply type “h” and hit @@ -98,7 +103,7 @@ suggestion. Input history from previous run is available as well. Available commands are listed in `Read The Docs`_. Theme customization -------------------- +^^^^^^^^^^^^^^^^^^^ Rainbow Stream is shipped with some default themes. You can either change theme by ``theme`` command or create your favorite one. @@ -125,9 +130,9 @@ Theme’s screenshot: .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png :alt: larapaste - For detaile information, see `theme usage and customization`_. + Bug and feature requests ------------------------ @@ -191,3 +196,5 @@ details .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/ .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode +.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/ +.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10