README.md
1# Windows Terminal Sequences
2
3This library allow for enabling Windows terminal color support for Go.
4
5See [Console Virtual Terminal Sequences](https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences) for details.
6
7## Usage
8
9```go
10import (
11 "syscall"
12
13 sequences "github.com/konsorten/go-windows-terminal-sequences"
14)
15
16func main() {
17 sequences.EnableVirtualTerminalProcessing(syscall.Stdout, true)
18}
19
20```
21
22## Authors
23
24The tool is sponsored by the [marvin + konsorten GmbH](http://www.konsorten.de).
25
26We thank all the authors who provided code to this library:
27
28* Felix Kollmann
29* Nicolas Perraut
30
31## License
32
33(The MIT License)
34
35Copyright (c) 2018 marvin + konsorten GmbH (open-source@konsorten.de)
36
37Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
38
39The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
40
41THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42