Modifying text to prefer tcell.

Jakub Sobon 2020-11-14 01:24:14 -05:00
parent b0d0024de3
commit 46d1402563
No known key found for this signature in database
GPG Key ID: F2451A77FB05D3B7
3 changed files with 6 additions and 4 deletions

@ -34,7 +34,7 @@ go run github.com/mum4k/termdash/termdashdemo/termdashdemo.go
## Supported Environments ## Supported Environments
Termdash is a higher level library that relies on libraries that expose a cell view of the terminal. Termdash currently uses [termbox-go](https://github.com/nsf/termbox-go). This means that Termdash supports all the environment that are supported by termbox-go. Termdash is a higher level library that relies on libraries that expose a cell view of the terminal. Termdash currently uses [tcell](https://github.com/gdamore/tcell). This means that Termdash supports all the environment that are supported by `tcell`.
### POSIX (Linux, FreeBSD, macOS, Solaris, etc.) ### POSIX (Linux, FreeBSD, macOS, Solaris, etc.)
@ -42,7 +42,7 @@ Most mainstream systems with well defined tty interface will work without any is
### Windows ### Windows
Windows applications are supported, e.g. native command prompt or power shell. Unfortunately **mintty** and other **cygwin** style application aren't supported since termbox-go doesn't support them. See this [issue](https://github.com/nsf/termbox-go/issues/66) for details. Windows applications are supported, e.g. native command prompt or power shell. Unfortunately **mintty** and other **cygwin** style application aren't supported since `tcell` doesn't support them.
## Similar projects in Go ## Similar projects in Go
@ -62,4 +62,4 @@ Windows applications are supported, e.g. native command prompt or power shell. U
## Questions or need help? ## Questions or need help?
See the [[Talk to us|Talk-to-us]] for different ways of getting in touch. See the [[Talk to us|Talk-to-us]] for different ways of getting in touch.

@ -2,6 +2,8 @@
The [termbox](https://godoc.org/github.com/mum4k/termdash/terminal/termbox) package implements the [[Terminal API|terminal-api]] using the [termbox-go](https://github.com/nsf/termbox-go). Termbox provides cell based access to the terminal. The [termbox](https://godoc.org/github.com/mum4k/termdash/terminal/termbox) package implements the [[Terminal API|terminal-api]] using the [termbox-go](https://github.com/nsf/termbox-go). Termbox provides cell based access to the terminal.
Prefer to use [[Tcell API|tcell-api]] instead, nsf/termbox-go is no longer maintained.
The public API surface of this package consists of the following: The public API surface of this package consists of the following:
## [termbox.New](https://godoc.org/github.com/mum4k/termdash/terminal/termbox#New) ## [termbox.New](https://godoc.org/github.com/mum4k/termdash/terminal/termbox#New)

@ -16,8 +16,8 @@
- [[Keyboard|keyboard-api]] - [[Keyboard|keyboard-api]]
- [[Mouse|mouse-api]] - [[Mouse|mouse-api]]
- [[Terminal|terminal-api]] - [[Terminal|terminal-api]]
- [[Termbox|termbox-api]]
- [[Tcell|tcell-api]] - [[Tcell|tcell-api]]
- [[Termbox|termbox-api]] (unsupported)
### Infrastructure layer ### Infrastructure layer