X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62;hp=b68e8c4e01d4056e0edd560c0bf9004c53b7d867;hb=ff858bfb99c554b1acc422ef1706c0ae7d2152e5;hpb=b84845b9062cd783bea1d206bc7355156550d45a diff --git a/README.rst b/README.rst index b68e8c4..7df81d8 100644 --- a/README.rst +++ b/README.rst @@ -16,32 +16,34 @@ Showcase ---------- Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s -Screenshot: - -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png - :alt: rainbowstream - -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png - :alt: rainbowstreamIOT Install ------- -You will need Python 2.7+ and pip. +The quick way +^^^^^^^^^^^^^ + +You will need Python 2.7 and pip. .. code:: bash sudo pip install rainbowstream -or try with a virtualenv + +The recommended way +^^^^^^^^^^^^^^^^^^^ + +Use `virtualenv`_ .. code:: bash - sudo pip install virtualenv # skip if you already have virtualenv virtualenv venv - source venv/bin/activate # use the brand new virtualenv. + # Python 3 users : use -p to specify your Python 3 localtion as below + # virtualenv -p /usr/bin/python3 venv + source venv/bin/activate pip install rainbowstream + Usage ----- @@ -52,7 +54,7 @@ Just type .. code:: bash - rainbow + rainbowstream and see your stream. @@ -61,7 +63,7 @@ You can try it with: .. code:: bash - rainbow -iot # Or rainbow --image-on-term + rainbowstream -iot # Or rainbowstream --image-on-term In the first time you will be asked for authorization of Rainbow Stream app at Twitter. Just click the “Authorize access” button and paste PIN @@ -78,9 +80,38 @@ Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well. -For available commands, please `Read The Docs`_. +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. + +Theme’s screenshot: + +- Monokai + +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png + :alt: monokai + +- Solarized + +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png + :alt: solarized + +- Tomorrow Night + +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png + :alt: tomorrownight + +- Larapaste + +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png + :alt: larapaste + -For themes and color setting, see `config guide`_. +For detaile information, see `theme usage and customization`_. Bug and feature requests ------------------------ @@ -107,4 +138,6 @@ details .. _fork: https://github.com/DTVD/rainbowstream/fork .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/ .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/ -.. _config guide: # +.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md +.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md +.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/