src/dma/vendor/github.com/labstack/gommon/color/README.md

   1 # Color
   2
   3 Style terminal text.
   4
   5 ## Installation
   6
   7 ```sh
   8 go get github.com/labstack/gommon/color
   9 ```
  10
  11 ## Windows?
  12
  13 Try [cmder](http://bliker.github.io/cmder) or https://github.com/mattn/go-colorable
  14
  15 ## [Usage](https://github.com/labstack/gommon/blob/master/color/color_test.go)
  16
  17 ```sh
  18 import github.com/labstack/gommon/color
  19 ```
  20
  21 ### Colored text
  22
  23 ```go
  24 color.Println(color.Black("black"))
  25 color.Println(color.Red("red"))
  26 color.Println(color.Green("green"))
  27 color.Println(color.Yellow("yellow"))
  28 color.Println(color.Blue("blue"))
  29 color.Println(color.Magenta("magenta"))
  30 color.Println(color.Cyan("cyan"))
  31 color.Println(color.White("white"))
  32 color.Println(color.Grey("grey"))
  33 ```
  34 ![Colored Text](http://i.imgur.com/8RtY1QR.png)
  35
  36 ### Colored background
  37
  38 ```go
  39 color.Println(color.BlackBg("black background", color.Wht))
  40 color.Println(color.RedBg("red background"))
  41 color.Println(color.GreenBg("green background"))
  42 color.Println(color.YellowBg("yellow background"))
  43 color.Println(color.BlueBg("blue background"))
  44 color.Println(color.MagentaBg("magenta background"))
  45 color.Println(color.CyanBg("cyan background"))
  46 color.Println(color.WhiteBg("white background"))
  47 ```
  48 ![Colored Background](http://i.imgur.com/SrrS6lw.png)
  49
  50 ### Emphasis
  51
  52 ```go
  53 color.Println(color.Bold("bold"))
  54 color.Println(color.Dim("dim"))
  55 color.Println(color.Italic("italic"))
  56 color.Println(color.Underline("underline"))
  57 color.Println(color.Inverse("inverse"))
  58 color.Println(color.Hidden("hidden"))
  59 color.Println(color.Strikeout("strikeout"))
  60 ```
  61 ![Emphasis](http://i.imgur.com/3RSJBbc.png)
  62
  63 ### Mix and match
  64
  65 ```go
  66 color.Println(color.Green("bold green with white background", color.B, color.WhtBg))
  67 color.Println(color.Red("underline red", color.U))
  68 color.Println(color.Yellow("dim yellow", color.D))
  69 color.Println(color.Cyan("inverse cyan", color.In))
  70 color.Println(color.Blue("bold underline dim blue", color.B, color.U, color.D))
  71 ```
  72 ![Mix and match](http://i.imgur.com/jWGq9Ca.png)
  73
  74 ### Enable/Disable the package
  75
  76 ```go
  77 color.Disable()
  78 color.Enable()
  79 ```
  80
  81 ### New instance
  82
  83 ```go
  84 c := New()
  85 c.Green("green")
  86 ```