OrgGo/tcell
1
0
Fork 0
mirror of https://github.com/gdamore/tcell.git synced 2025-04-27 13:48:50 +08:00
Code Issues Projects Releases Wiki Activity

Fix status badges (broken by shields.io)

Browse Source
This commit is contained in:
Garrett D'Amore 2022-12-31 09:12:50 -08:00
parent dc01b79c87
commit 0fb7c000c5
1 changed files with 75 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
README.md
View File

@ -6,8 +6,8 @@ _Tcell_ is a _Go_ package that provides a cell based view for text terminals, li
It was inspired by _termbox_, but includes many additional improvements. It was inspired by _termbox_, but includes many additional improvements.
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua) [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
[![Linux](https://img.shields.io/github/workflow/status/gdamore/tcell/linux?logoColor=grey&logo=linux&label=)](https://github.com/gdamore/tcell/actions/workflows/linux.yml) [![Linux](https://img.shields.io/github/actions/workflow/status/gdamore/tcell/linux.yml?branch=main&logoColor=grey&logo=linux&label=)](https://github.com/gdamore/tcell/actions/workflows/linux.yml)
[![Windows](https://img.shields.io/github/workflow/status/gdamore/tcell/windows?logoColor=grey&logo=windows&label=)](https://github.com/gdamore/tcell/actions/workflows/windows.yml) [![Windows](https://img.shields.io/github/actions/workflow/status/gdamore/tcell/windows.yml?branch=main&logoColor=grey&logo=windows&label=)](https://github.com/gdamore/tcell/actions/workflows/windows.yml)
[![Apache License](https://img.shields.io/github/license/gdamore/tcell.svg?logoColor=silver&logo=opensourceinitiative&color=blue&label=)](https://github.com/gdamore/tcell/blob/master/LICENSE) [![Apache License](https://img.shields.io/github/license/gdamore/tcell.svg?logoColor=silver&logo=opensourceinitiative&color=blue&label=)](https://github.com/gdamore/tcell/blob/master/LICENSE)
[![Docs](https://img.shields.io/badge/godoc-reference-blue.svg?label=&logo=go)](https://pkg.go.dev/github.com/gdamore/tcell/v2) [![Docs](https://img.shields.io/badge/godoc-reference-blue.svg?label=&logo=go)](https://pkg.go.dev/github.com/gdamore/tcell/v2)
[![Discord](https://img.shields.io/discord/639503822733180969?label=&logo=discord)](https://discord.gg/urTTxDN) [![Discord](https://img.shields.io/discord/639503822733180969?label=&logo=discord)](https://discord.gg/urTTxDN)
@ -25,46 +25,46 @@ A brief, and still somewhat rough, [tutorial](TUTORIAL.md) is available.
## Examples ## Examples
* [proxima5](https://github.com/gdamore/proxima5) - space shooter ([video](https://youtu.be/jNxKTCmY_bQ)) - [proxima5](https://github.com/gdamore/proxima5) - space shooter ([video](https://youtu.be/jNxKTCmY_bQ))
* [govisor](https://github.com/gdamore/govisor) - service management UI ([screenshot](http://2.bp.blogspot.com/--OsvnfzSNow/Vf7aqMw3zXI/AAAAAAAAARo/uOMtOvw4Sbg/s1600/Screen%2BShot%2B2015-09-20%2Bat%2B9.08.41%2BAM.png)) - [govisor](https://github.com/gdamore/govisor) - service management UI ([screenshot](http://2.bp.blogspot.com/--OsvnfzSNow/Vf7aqMw3zXI/AAAAAAAAARo/uOMtOvw4Sbg/s1600/Screen%2BShot%2B2015-09-20%2Bat%2B9.08.41%2BAM.png))
* mouse demo - included mouse test ([screenshot](http://2.bp.blogspot.com/-fWvW5opT0es/VhIdItdKqJI/AAAAAAAAATE/7Ojc0L1SpB0/s1600/Screen%2BShot%2B2015-10-04%2Bat%2B11.47.13%2BPM.png)) - mouse demo - included mouse test ([screenshot](http://2.bp.blogspot.com/-fWvW5opT0es/VhIdItdKqJI/AAAAAAAAATE/7Ojc0L1SpB0/s1600/Screen%2BShot%2B2015-10-04%2Bat%2B11.47.13%2BPM.png))
* [gomatrix](https://github.com/gdamore/gomatrix) - converted from Termbox - [gomatrix](https://github.com/gdamore/gomatrix) - converted from Termbox
* [micro](https://github.com/zyedidia/micro/) - lightweight text editor with syntax-highlighting and themes - [micro](https://github.com/zyedidia/micro/) - lightweight text editor with syntax-highlighting and themes
* [godu](https://github.com/viktomas/godu) - utility to discover large files/folders - [godu](https://github.com/viktomas/godu) - utility to discover large files/folders
* [tview](https://github.com/rivo/tview/) - rich interactive widgets - [tview](https://github.com/rivo/tview/) - rich interactive widgets
* [cview](https://code.rocketnine.space/tslocum/cview) - user interface toolkit (fork of _tview_) - [cview](https://code.rocketnine.space/tslocum/cview) - user interface toolkit (fork of _tview_)
* [awsome gocui](https://github.com/awesome-gocui/gocui) - Go Console User Interface - [awsome gocui](https://github.com/awesome-gocui/gocui) - Go Console User Interface
* [gomandelbrot](https://github.com/rgm3/gomandelbrot) - Mandelbrot! - [gomandelbrot](https://github.com/rgm3/gomandelbrot) - Mandelbrot!
* [WTF](https://github.com/senorprogrammer/wtf) - personal information dashboard - [WTF](https://github.com/senorprogrammer/wtf) - personal information dashboard
* [browsh](https://github.com/browsh-org/browsh) - modern web browser ([video](https://www.youtube.com/watch?v=HZq86XfBoRo)) - [browsh](https://github.com/browsh-org/browsh) - modern web browser ([video](https://www.youtube.com/watch?v=HZq86XfBoRo))
* [go-life](https://github.com/sachaos/go-life) - Conway's Game of Life - [go-life](https://github.com/sachaos/go-life) - Conway's Game of Life
* [gowid](https://github.com/gcla/gowid) - compositional widgets for terminal UIs, inspired by _urwid_ - [gowid](https://github.com/gcla/gowid) - compositional widgets for terminal UIs, inspired by _urwid_
* [termshark](https://termshark.io) - interface for _tshark_, inspired by Wireshark, built on _gowid_ - [termshark](https://termshark.io) - interface for _tshark_, inspired by Wireshark, built on _gowid_
* [go-tetris](https://github.com/MichaelS11/go-tetris) - Go Tetris with AI option - [go-tetris](https://github.com/MichaelS11/go-tetris) - Go Tetris with AI option
* [fzf](https://github.com/junegunn/fzf) - command-line fuzzy finder - [fzf](https://github.com/junegunn/fzf) - command-line fuzzy finder
* [ascii-fluid](https://github.com/esimov/ascii-fluid) - fluid simulation controlled by webcam - [ascii-fluid](https://github.com/esimov/ascii-fluid) - fluid simulation controlled by webcam
* [cbind](https://code.rocketnine.space/tslocum/cbind) - key event encoding, decoding and handling - [cbind](https://code.rocketnine.space/tslocum/cbind) - key event encoding, decoding and handling
* [tpong](https://github.com/spinzed/tpong) - old-school Pong - [tpong](https://github.com/spinzed/tpong) - old-school Pong
* [aerc](https://git.sr.ht/~sircmpwn/aerc) - email client - [aerc](https://git.sr.ht/~sircmpwn/aerc) - email client
* [tblogs](https://github.com/ezeoleaf/tblogs) - development blogs reader - [tblogs](https://github.com/ezeoleaf/tblogs) - development blogs reader
* [spinc](https://github.com/lallassu/spinc) - _irssi_ inspired chat application for Cisco Spark/WebEx - [spinc](https://github.com/lallassu/spinc) - _irssi_ inspired chat application for Cisco Spark/WebEx
* [gorss](https://github.com/lallassu/gorss) - RSS/Atom feed reader - [gorss](https://github.com/lallassu/gorss) - RSS/Atom feed reader
* [memoryalike](https://github.com/Bios-Marcel/memoryalike) - memorization game - [memoryalike](https://github.com/Bios-Marcel/memoryalike) - memorization game
* [lf](https://github.com/gokcehan/lf) - file manager - [lf](https://github.com/gokcehan/lf) - file manager
* [goful](https://github.com/anmitsu/goful) - CUI file manager - [goful](https://github.com/anmitsu/goful) - CUI file manager
* [gokeybr](https://github.com/bunyk/gokeybr) - deliberately practice your typing - [gokeybr](https://github.com/bunyk/gokeybr) - deliberately practice your typing
* [gonano](https://github.com/jbaramidze/gonano) - editor, mimics _nano_ - [gonano](https://github.com/jbaramidze/gonano) - editor, mimics _nano_
* [uchess](https://github.com/tmountain/uchess) - UCI chess client - [uchess](https://github.com/tmountain/uchess) - UCI chess client
* [min](https://github.com/a-h/min) - Gemini browser - [min](https://github.com/a-h/min) - Gemini browser
* [ov](https://github.com/noborus/ov) - file pager - [ov](https://github.com/noborus/ov) - file pager
* [tmux-wormhole](https://github.com/gcla/tmux-wormhole) - _tmux_ plugin to transfer files - [tmux-wormhole](https://github.com/gcla/tmux-wormhole) - _tmux_ plugin to transfer files
* [gruid-tcell](https://github.com/anaseto/gruid-tcell) - driver for the grid based UI and game framework - [gruid-tcell](https://github.com/anaseto/gruid-tcell) - driver for the grid based UI and game framework
* [aretext](https://github.com/aretext/aretext) - minimalist text editor with _vim_ key bindings - [aretext](https://github.com/aretext/aretext) - minimalist text editor with _vim_ key bindings
* [sync](https://github.com/kyprifog/sync) - GitHub repo synchronization tool - [sync](https://github.com/kyprifog/sync) - GitHub repo synchronization tool
* [statusbar](https://github.com/kyprifog/statusbar) - statusbar motivation tool for tracking periodic tasks/goals - [statusbar](https://github.com/kyprifog/statusbar) - statusbar motivation tool for tracking periodic tasks/goals
* [todo](https://github.com/kyprifog/todo) - simple todo app - [todo](https://github.com/kyprifog/todo) - simple todo app
* [gosnakego](https://github.com/liweiyi88/gosnakego) - a snake game - [gosnakego](https://github.com/liweiyi88/gosnakego) - a snake game
* [gbb](https://github.com/sdemingo/gbb) - A classical bulletin board app for tildes or public unix servers - [gbb](https://github.com/sdemingo/gbb) - A classical bulletin board app for tildes or public unix servers
## Pure Go Terminfo Database ## Pure Go Terminfo Database
@ -177,20 +177,20 @@ We follow the (inaccurate) common convention.
There are a few ways you can enable (or disable) true color. There are a few ways you can enable (or disable) true color.
* For many terminals, we can detect it automatically if your terminal - For many terminals, we can detect it automatically if your terminal
includes the `RGB` or `Tc` capabilities (or rather it did when the database includes the `RGB` or `Tc` capabilities (or rather it did when the database
was updated.) was updated.)
* You can force this one by setting the `COLORTERM` environment variable to - You can force this one by setting the `COLORTERM` environment variable to
`24-bit`, `truecolor` or `24bit`. This is the same method used `24-bit`, `truecolor` or `24bit`. This is the same method used
by most other terminal applications that support 24-bit color. by most other terminal applications that support 24-bit color.
* If you set your `TERM` environment variable to a value with the suffix `-truecolor` - If you set your `TERM` environment variable to a value with the suffix `-truecolor`
then 24-bit color compatible with XTerm and ECMA-48 will be assumed. then 24-bit color compatible with XTerm and ECMA-48 will be assumed.
(This feature is deprecated. (This feature is deprecated.
It is recommended to use one of other methods listed above.) It is recommended to use one of other methods listed above.)
* You can disable 24-bit color by setting `TCELL_TRUECOLOR=disable` in your - You can disable 24-bit color by setting `TCELL_TRUECOLOR=disable` in your
environment. environment.
When using TrueColor, programs will display the colors that the programmer When using TrueColor, programs will display the colors that the programmer
@ -278,5 +278,5 @@ please let me know. PRs are especially welcome.
_Tcell_ is absolutely free, but if you want to obtain commercial, professional support, there are options. _Tcell_ is absolutely free, but if you want to obtain commercial, professional support, there are options.
* [TideLift](https://tidelift.com/) subscriptions include support for _Tcell_, as well as many other open source packages. - [TideLift](https://tidelift.com/) subscriptions include support for _Tcell_, as well as many other open source packages.
* [Staysail Systems Inc.](mailto:info@staysail.tech) offers direct support, and custom development around _Tcell_ on an hourly basis. - [Staysail Systems Inc.](mailto:info@staysail.tech) offers direct support, and custom development around _Tcell_ on an hourly basis.