theme.md

   1 ## Available themes
   2 #### Default
   3 ![Default](./screenshot/themes/Default.png)
   4 #### Monokai
   5 ![Monokai](./screenshot/themes/Monokai.png)
   6 #### Solarized
   7 ![Solarized](./screenshot/themes/Solarized.png)
   8
   9 ## Customize:
  10 You are free to create your own themes.
  11
  12 Create a file `~/.rainbow_config.json` and follow next instruction.
  13 Examples are available in
  14 [Monokai theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/monokai.json)
  15 or
  16 [Solarized theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json)
  17
  18 ### Custom config
  19  * Config file should be excatly named `.rainbow_config.json` and placed at home directory.
  20  * Config file's content should follow `Json` format.
  21  * Comment as `//` or `/*...*/` is accepted.
  22  * Here is an example
  23
  24 ```json
  25  /* Color config
  26     There are 16 basic colors supported :
  27         * default
  28         * black
  29         * red
  30         * green
  31         * yellow
  32         * blue
  33         * magenta
  34         * cyan
  35         * grey
  36         * light_red
  37         * light_green
  38         * light_yellow
  39         * light_blue
  40         * light_magenta
  41         * light_cyan
  42         * white
  43     and 256 terminal's colors from term_0 to term_255
  44     */
  45
  46     "DECORATED_NAME" : "term_198",
  47     "CYCLE_COLOR" :["term_198","term_57","term_166","term_50","term_179","term_74","term_112"],
  48     "TWEET" : {
  49         "nick"      : "term_112",
  50         "clock"     : "term_57",
  51         "id"        : "term_166",
  52         "favourite" : "term_50",
  53         "rt"        : "term_179",
  54         "link"      : "term_74",
  55         "keyword"   : "on_light_green"
  56     },
  57
  58     "MESSAGE" : {
  59         "sender"    : "term_112",
  60         "recipient" : "term_112",
  61         "to"        : "term_50",
  62         "clock"     : "term_57",
  63         "id"        : "term_166"
  64     },
  65
  66     "PROFILE" : {
  67         "statuses_count"    : "term_112",
  68         "friends_count"     : "term_198",
  69         "followers_count"   : "term_57",
  70         "nick"              : "term_198",
  71         "profile_image_url" : "term_74",
  72         "description"       : "term_166",
  73         "location"          : "term_112",
  74         "url"               : "term_74",
  75         "clock"             : "term_57"
  76     },
  77
  78     "TREND" : {
  79         "url": "term_74"
  80     }
  81 }
  82 ```
  83
  84 ### Available Colors
  85
  86 There are 16 basic colors:
  87   * default
  88   * black
  89   * red
  90   * green
  91   * yellow
  92   * blue
  93   * magenta
  94   * cyan
  95   * grey
  96   * light_red
  97   * light_green
  98   * light_yellow
  99   * light_blue
 100   * light_magenta
 101   * light_cyan
 102   * white
 103
 104 These colors will be enough for almost terminals.
 105 But if your terminals can support 256 colors (check your `$XTERM` variable!),
 106 you can even use `term_0` to `term_255` as sample above.
 107
 108 Color reference can be found at
 109 [bash color](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
 110 [256 xterm](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html)
 111
 112 ### Available options
 113 * DECORATED_NAME: color of your Twitter's _username_ which is placed at every line's begin.
 114 * CYCLE_COLOR: is a list of colors from which Twitter _real name_ 's color is selected.
 115
 116 ⋅⋅* Color selection is cycle through this list but with a _memoization_.
 117 ⋅⋅* It's means that same names will appear in same colors.
 118
 119
 120