X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62;hp=6d124ef57300af8e6c2bc29e4b4559a054ffc9f9;hb=45e6bb0df0f868a841c41e51e905a679f5ce2015;hpb=c1a3d5e53fd6982f42cff73956588f0130497be7 diff --git a/README.rst b/README.rst index 6d124ef..7df81d8 100644 --- a/README.rst +++ b/README.rst @@ -14,34 +14,36 @@ This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_. Showcase ---------- -Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s +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. + virtualenv venv + # 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,14 +80,43 @@ 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 ------------------------ -Found a bug or a feature request ? +Found a bug or a feature request ? Please `create an issue`_ or contact me at `@dtvd88`_ Contributing @@ -106,5 +137,7 @@ details .. _@dtvd88: https://twitter.com/dtvd88 .. _fork: https://github.com/DTVD/rainbowstream/fork .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/ -.. _Read The Dics: http://rainbowstream.readthedocs.org/en/latest/ -.. _config guide: # +.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/ +.. _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/