document
authorOrakaro <nhatminh_179@hotmail.com>
Thu, 3 Jul 2014 12:58:28 +0000 (21:58 +0900)
committerOrakaro <nhatminh_179@hotmail.com>
Thu, 3 Jul 2014 12:58:28 +0000 (21:58 +0900)
README.md
README.rst
docs/index.rst
screenshot/themes/Default.png [new file with mode: 0644]
screenshot/themes/Monokai.png [new file with mode: 0644]
screenshot/themes/Solarized.png [new file with mode: 0644]
theme.md [new file with mode: 0644]

index 77f9abd..9e6014e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Realtime tweetstream, compose, search , favorite ... and much more fun directly
 This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
 
 ## Showcase
-Screencast: 
+Screencast:
 https://www.youtube.com/watch?v=tykCvPMJq8s
 <br>
 
@@ -28,7 +28,7 @@ sudo pip install rainbowstream
 or try with a virtualenv
 ```bash
 sudo pip install virtualenv # skip if you already have virtualenv
-virtualenv venv 
+virtualenv venv
 source venv/bin/activate # use the brand new virtualenv.
 pip install rainbowstream
 ```
@@ -63,14 +63,14 @@ For available commands, please [Read The Docs](http://rainbowstream.readthedocs.
 For themes and color setting, see [config guide](#).
 
 ## Bug and feature requests
-Found a bug or a feature request ? 
+Found a bug or a feature request ?
 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## Contributing
-I appreciate any help and support. Feel free to 
-[fork](https://github.com/DTVD/rainbowstream/fork) 
-and 
+I appreciate any help and support. Feel free to
+[fork](https://github.com/DTVD/rainbowstream/fork)
+and
 [create a pull request](https://github.com/DTVD/rainbowstream/compare/).
 You will be listed as contributor.
 
index 982eed9..b68e8c4 100644 (file)
@@ -14,9 +14,9 @@ This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
 \r
 Showcase\r
 ----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
-Screenshot: \r
+Screenshot:\r
 \r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
    :alt: rainbowstream\r
@@ -32,13 +32,13 @@ You will need Python 2.7+ and pip.
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
-    \r
+\r
 or try with a virtualenv\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
     pip install rainbowstream\r
 \r
@@ -85,7 +85,7 @@ For themes and color setting, see `config guide`_.
 Bug and feature requests\r
 ------------------------\r
 \r
-Found a bug or a feature request ? \r
+Found a bug or a feature request ?\r
 Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 Contributing\r
index 4f14854..5a9118c 100644 (file)
@@ -20,13 +20,13 @@ You will need Python 2.7+ and pip.
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
-    \r
+\r
 or try with a virtualenv\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
     pip install rainbowstream\r
 \r
@@ -172,6 +172,9 @@ Here is full list of supported command:
 \r
 **Screening Commands**\r
 \r
+-  ``theme`` will list available themes. ``theme monokai`` will apply *monokai*\r
+theme immedaitely.\r
+\r
 -  ``h`` will show the help.\r
 \r
 -  ``c`` will clear the screen.\r
diff --git a/screenshot/themes/Default.png b/screenshot/themes/Default.png
new file mode 100644 (file)
index 0000000..61e4bdc
Binary files /dev/null and b/screenshot/themes/Default.png differ
diff --git a/screenshot/themes/Monokai.png b/screenshot/themes/Monokai.png
new file mode 100644 (file)
index 0000000..0da6361
Binary files /dev/null and b/screenshot/themes/Monokai.png differ
diff --git a/screenshot/themes/Solarized.png b/screenshot/themes/Solarized.png
new file mode 100644 (file)
index 0000000..50df993
Binary files /dev/null and b/screenshot/themes/Solarized.png differ
diff --git a/theme.md b/theme.md
new file mode 100644 (file)
index 0000000..8ebdb69
--- /dev/null
+++ b/theme.md
@@ -0,0 +1,16 @@
+## Available themes:
+#### Default
+![Default](./screenshot/themes/Default.png)
+#### Monokai
+![Monokai](./screenshot/themes/Monokai.png)
+#### Solarized
+![Solarized](./screenshot/themes/Solarized.png)
+
+## Customize:
+You are free to create your own themes.
+Create a file `~/.rainbow_config.json` and see the example for
+[Monokai](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/monokai.json)
+or
+[Solarized](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json)
+
+Comment as `//` or `/**/` is accepted.
\ No newline at end of file