X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=theme.md;h=d6ec1c9db5a543cac0092db1c76e50326c64b547;hp=3a696f2c40a12f95bb5c1f153fe3eba28b177329;hb=06302419959d8b8ea91ff8e2b45492743256c7b5;hpb=bd97b07c5e0bdd5fa95b10758385852c06e3f82b diff --git a/theme.md b/theme.md index 3a696f2..d6ec1c9 100644 --- a/theme.md +++ b/theme.md @@ -6,16 +6,16 @@ #### Solarized ![Solarized](./screenshot/themes/Solarized.png) -## Customize: +## Customization Create a file `~/.rainbow_config.json` and follow next instruction. -Examples are available in +Examples are available in [Monokai theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/monokai.json) or [Solarized theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json). ### Custom config - * Config file's name should be excatly `.rainbow_config.json` and placed at home directory. + * Config file's name should be exactly `.rainbow_config.json` and placed at home directory. * Config file's content should follow json format. * Comments as `//` or `/*...*/` are allowed. * Here is an example @@ -81,17 +81,17 @@ There are 16 basic colors: * white These colors will be enough for almost terminals. -But if your terminals can support 256 colors (check your `$TERM` variable!), -you can even use `term_0` to `term_255` as examples above. +But if your terminal can support 256 colors (check your `$TERM` variable!), +you can even use `term_0` to `term_255` as the example above. -Color reference can be found at -[bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or +Color reference can be found at +[bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or [256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html). ### Available options * `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin. -* `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected. - * Color selection is cycle through this list but with a _memoization_. +* `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected. + * Color selection is cycle through this list but with _memoization_. * It's means that same names will appear in same colors. * `TWEET`: colors of parts in a tweet's ouput. * `nick` : color for Twitter __username__. @@ -100,7 +100,7 @@ Color reference can be found at * `favorite`: color for the star symbol when a tweet is favorited by you * `rt`: color for `RT` word in tweet's content. * `link`: color for an url - * `keyword`: color for highlighted keyword (in tweets search) + * `keyword`: color for highlighted keyword (in tweets search) * `MESSAGE`: colors of parts in message's output. * `sender`: color for sender's __username__. * `recipient`: color for recipient's __username__. @@ -120,3 +120,13 @@ Color reference can be found at * `TREND`: colors for trend's output: * `url`: color for trend's url. +### Theme usage +While entered Rainbow Stream: +* `theme` and hit ENTER to see which is available. +* `theme` + TAB twice will show themes list instantly. +* `theme monokai` will apply `monokai` theme immediately. You can use TAB key for theme's name autocompletion. + +### Theme contribution +I appreciate any contribution for themes for this app. +Please add a file to [themes folder](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream/colorset) +(json format!) and create a [pull request](https://github.com/DTVD/rainbowstream/compare/) with a screenshot.