X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=f2dd4eb76255c2fb5df25b7e85b0dcfad071200c;hp=461a2e1346c6366a7ebade55bf0c1eee76ab9839;hb=3b9d45936cfcb7d5ad0707f34ba529731fc0ab8b;hpb=33ce4cdb0c2282d804fb07ccb33d384af077aa5f diff --git a/README.rst b/README.rst index 461a2e1..f2dd4eb 100644 --- a/README.rst +++ b/README.rst @@ -23,13 +23,19 @@ Showcase Install ------- -Requirements +Prerequisite ^^^^^^^^^^^^ -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``. +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 +.. code:: bash + + sudo apt-get install python-dev libsqlite3-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. The quick way ^^^^^^^^^^^^^ @@ -85,7 +91,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 +104,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 +131,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 +197,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