From 46d1402563722378fb36790e4e212c1642b6f711 Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sat, 14 Nov 2020 01:24:14 -0500 Subject: [PATCH] Modifying text to prefer tcell. --- Home.md | 6 +++--- Termbox-API.md | 2 ++ _Sidebar.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Home.md b/Home.md index fe16d4f..79f8896 100644 --- a/Home.md +++ b/Home.md @@ -34,7 +34,7 @@ go run github.com/mum4k/termdash/termdashdemo/termdashdemo.go ## 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.) @@ -42,7 +42,7 @@ Most mainstream systems with well defined tty interface will work without any is ### 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 @@ -62,4 +62,4 @@ Windows applications are supported, e.g. native command prompt or power shell. U ## Questions or need help? -See the [[Talk to us|Talk-to-us]] for different ways of getting in touch. \ No newline at end of file +See the [[Talk to us|Talk-to-us]] for different ways of getting in touch. diff --git a/Termbox-API.md b/Termbox-API.md index 7e35d1e..bdbe81f 100644 --- a/Termbox-API.md +++ b/Termbox-API.md @@ -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. +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: ## [termbox.New](https://godoc.org/github.com/mum4k/termdash/terminal/termbox#New) diff --git a/_Sidebar.md b/_Sidebar.md index d383968..d24f572 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -16,8 +16,8 @@ - [[Keyboard|keyboard-api]] - [[Mouse|mouse-api]] - [[Terminal|terminal-api]] - - [[Termbox|termbox-api]] - [[Tcell|tcell-api]] + - [[Termbox|termbox-api]] (unsupported) ### Infrastructure layer