Update README.rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 4de4283c00f04b068888fc982f1b6a0f4efb4e83..7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -16,32 +16,34 @@ Showcase
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r

-Screenshot:\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: rainbowstream\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: rainbowstreamIOT\r

 \r
 Install\r
 -------\r
 \r
 \r
 Install\r
 -------\r
 \r

-You will need Python 2.7+ and pip.\r
+The quick way\r
+^^^^^^^^^^^^^\r
+\r
+You will need Python 2.7 and pip.\r

 \r
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
 \r
 \r
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
 \r

-or try with a virtualenv\r
+\r
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+Use `virtualenv`_\r

 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \r

-    sudo pip install virtualenv # skip if you already have virtualenv\r

     virtualenv venv\r
     virtualenv venv\r

-    source venv/bin/activate # use the brand new virtualenv.\r
+    # Python 3 users : use -p to specify your Python 3 localtion as below\r
+    # virtualenv -p /usr/bin/python3 venv\r
+    source venv/bin/activate\r

     pip install rainbowstream\r
 \r
     pip install rainbowstream\r
 \r

+\r

 Usage\r
 -----\r
 \r
 Usage\r
 -----\r
 \r


@@ -52,7 +54,7 @@ Just type
 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \r

-    rainbow\r
+    rainbowstream\r

 \r
 and see your stream.\r
 \r
 \r
 and see your stream.\r
 \r


@@ -61,7 +63,7 @@ You can try it with:
 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \r

-    rainbow -iot # Or rainbow --image-on-term\r
+    rainbowstream -iot # Or rainbowstream --image-on-term\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
 \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


@@ -83,15 +85,32 @@ Available commands are listed in `Read The Docs`_.
 Theme customization\r
 ------------------------\r
 \r
 Theme customization\r
 ------------------------\r
 \r

-Rainbow Stream is shipped with some default themes. \r
+Rainbow Stream is shipped with some default themes.\r

 You can either change theme by ``theme`` command or create your favorite one.\r
 \r
 Theme’s screenshot:\r
 You can either change theme by ``theme`` command or create your favorite one.\r
 \r
 Theme’s screenshot:\r

+\r
+- Monokai\r
+\r

 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
    :alt: monokai\r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
    :alt: monokai\r

+\r
+- Solarized\r
+\r

 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
    :alt: solarized\r
 \r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
    :alt: solarized\r
 \r

+- Tomorrow Night\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+   :alt: tomorrownight\r
+\r
+- Larapaste\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r
+\r
+\r

 For detaile information, see `theme usage and customization`_.\r
 \r
 Bug and feature requests\r
 For detaile information, see `theme usage and customization`_.\r
 \r
 Bug and feature requests\r


@@ -121,3 +140,4 @@ details
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\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