-
-
Notifications
You must be signed in to change notification settings - Fork 313
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix status badges (broken by shields.io)
- Loading branch information
Showing
1 changed file
with
75 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
| [](https://stand-with-ukraine.pp.ua) | ||
| [](https://github.com/gdamore/tcell/actions/workflows/linux.yml) | ||
| [](https://github.com/gdamore/tcell/actions/workflows/windows.yml) | ||
| [](https://github.com/gdamore/tcell/actions/workflows/linux.yml) | ||
| [](https://github.com/gdamore/tcell/actions/workflows/windows.yml) | ||
| [](https://github.com/gdamore/tcell/blob/master/LICENSE) | ||
| [](https://pkg.go.dev/github.com/gdamore/tcell/v2) | ||
| [](https://discord.gg/urTTxDN) | ||
|
|
@@ -16,7 +16,7 @@ It was inspired by _termbox_, but includes many additional improvements. | |
|
|
||
| Please see [here](UKRAINE.md) for an important message for the people of Russia. | ||
|
|
||
| NOTE: This is version 2 of _Tcell_. There are breaking changes relative to version 1. | ||
| NOTE: This is version 2 of _Tcell_. There are breaking changes relative to version 1. | ||
| Version 1.x remains available using the import `github.com/gdamore/tcell`. | ||
|
|
||
| ## Tutorial | ||
|
|
@@ -25,51 +25,51 @@ A brief, and still somewhat rough, [tutorial](TUTORIAL.md) is available. | |
|
|
||
| ## Examples | ||
|
|
||
| * [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)) | ||
| * 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 | ||
| * [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 | ||
| * [tview](https://github.com/rivo/tview/) - rich interactive widgets | ||
| * [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 | ||
| * [gomandelbrot](https://github.com/rgm3/gomandelbrot) - Mandelbrot! | ||
| * [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)) | ||
| * [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_ | ||
| * [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 | ||
| * [fzf](https://github.com/junegunn/fzf) - command-line fuzzy finder | ||
| * [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 | ||
| * [tpong](https://github.com/spinzed/tpong) - old-school Pong | ||
| * [aerc](https://git.sr.ht/~sircmpwn/aerc) - email client | ||
| * [tblogs](https://github.com/ezeoleaf/tblogs) - development blogs reader | ||
| * [spinc](https://github.com/lallassu/spinc) - _irssi_ inspired chat application for Cisco Spark/WebEx | ||
| * [gorss](https://github.com/lallassu/gorss) - RSS/Atom feed reader | ||
| * [memoryalike](https://github.com/Bios-Marcel/memoryalike) - memorization game | ||
| * [lf](https://github.com/gokcehan/lf) - file manager | ||
| * [goful](https://github.com/anmitsu/goful) - CUI file manager | ||
| * [gokeybr](https://github.com/bunyk/gokeybr) - deliberately practice your typing | ||
| * [gonano](https://github.com/jbaramidze/gonano) - editor, mimics _nano_ | ||
| * [uchess](https://github.com/tmountain/uchess) - UCI chess client | ||
| * [min](https://github.com/a-h/min) - Gemini browser | ||
| * [ov](https://github.com/noborus/ov) - file pager | ||
| * [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 | ||
| * [aretext](https://github.com/aretext/aretext) - minimalist text editor with _vim_ key bindings | ||
| * [sync](https://github.com/kyprifog/sync) - GitHub repo synchronization tool | ||
| * [statusbar](https://github.com/kyprifog/statusbar) - statusbar motivation tool for tracking periodic tasks/goals | ||
| * [todo](https://github.com/kyprifog/todo) - simple todo app | ||
| * [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 | ||
| - [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)) | ||
| - 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 | ||
| - [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 | ||
| - [tview](https://github.com/rivo/tview/) - rich interactive widgets | ||
| - [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 | ||
| - [gomandelbrot](https://github.com/rgm3/gomandelbrot) - Mandelbrot! | ||
| - [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)) | ||
| - [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_ | ||
| - [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 | ||
| - [fzf](https://github.com/junegunn/fzf) - command-line fuzzy finder | ||
| - [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 | ||
| - [tpong](https://github.com/spinzed/tpong) - old-school Pong | ||
| - [aerc](https://git.sr.ht/~sircmpwn/aerc) - email client | ||
| - [tblogs](https://github.com/ezeoleaf/tblogs) - development blogs reader | ||
| - [spinc](https://github.com/lallassu/spinc) - _irssi_ inspired chat application for Cisco Spark/WebEx | ||
| - [gorss](https://github.com/lallassu/gorss) - RSS/Atom feed reader | ||
| - [memoryalike](https://github.com/Bios-Marcel/memoryalike) - memorization game | ||
| - [lf](https://github.com/gokcehan/lf) - file manager | ||
| - [goful](https://github.com/anmitsu/goful) - CUI file manager | ||
| - [gokeybr](https://github.com/bunyk/gokeybr) - deliberately practice your typing | ||
| - [gonano](https://github.com/jbaramidze/gonano) - editor, mimics _nano_ | ||
| - [uchess](https://github.com/tmountain/uchess) - UCI chess client | ||
| - [min](https://github.com/a-h/min) - Gemini browser | ||
| - [ov](https://github.com/noborus/ov) - file pager | ||
| - [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 | ||
| - [aretext](https://github.com/aretext/aretext) - minimalist text editor with _vim_ key bindings | ||
| - [sync](https://github.com/kyprifog/sync) - GitHub repo synchronization tool | ||
| - [statusbar](https://github.com/kyprifog/statusbar) - statusbar motivation tool for tracking periodic tasks/goals | ||
| - [todo](https://github.com/kyprifog/todo) - simple todo app | ||
| - [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 | ||
|
|
||
| ## Pure Go Terminfo Database | ||
|
|
||
| _Tcell_ includes a full parser and expander for terminfo capability strings, | ||
| so that it can avoid hard coding escape strings for formatting. It also favors | ||
| so that it can avoid hard coding escape strings for formatting. It also favors | ||
| portability, and includes support for all POSIX systems. | ||
|
|
||
| The database is also flexible & extensible, and can be modified by either running | ||
|
|
@@ -114,7 +114,7 @@ For example attempts to emit color sequences on VT100 terminals | |
| won't result in unintended consequences. | ||
|
|
||
| In legacy Windows mode, _Tcell_ supports 16 colors, bold, dim, and reverse, | ||
| instead of just termbox's 8 colors with reverse. (Note that there is some | ||
| instead of just termbox's 8 colors with reverse. (Note that there is some | ||
| conflation with bold/dim and colors.) | ||
| Modern Windows 10 can benefit from much richer colors however. | ||
|
|
||
|
|
@@ -127,7 +127,7 @@ _Tcell_ supports enhanced mouse tracking mode, so your application can receive | |
| regular mouse motion events, and wheel events, if your terminal supports it. | ||
|
|
||
| (Note: The Windows 10 Terminal application suffers from a flaw in this regard, | ||
| and does not support mouse interaction. The stock Windows 10 console host | ||
| and does not support mouse interaction. The stock Windows 10 console host | ||
| fired up with cmd.exe or PowerShell works fine however.) | ||
|
|
||
| ## _Termbox_ Compatibility | ||
|
|
@@ -152,7 +152,7 @@ The `SetContent()` API takes a primary rune, and an optional list of combining r | |
| If any of the runes is a wide (East Asian) rune occupying two cells, | ||
| then the library will skip output from the following cell. Care must be | ||
| taken in the application to avoid explicitly attempting to set content in the | ||
| next cell, otherwise the results are undefined. (Normally the wide character | ||
| next cell, otherwise the results are undefined. (Normally the wide character | ||
| is displayed, and the other character is not; do not depend on that behavior.) | ||
|
|
||
| Older terminal applications (especially on systems like Windows 8) lack support | ||
|
|
@@ -161,42 +161,42 @@ for advanced Unicode, and thus may not fare well. | |
| ## Colors | ||
|
|
||
| _Tcell_ assumes the ANSI/XTerm color model, including the 256 color map that | ||
| XTerm uses when it supports 256 colors. The terminfo guidance will be | ||
| honored, with respect to the number of colors supported. Also, only | ||
| XTerm uses when it supports 256 colors. The terminfo guidance will be | ||
| honored, with respect to the number of colors supported. Also, only | ||
| terminals which expose ANSI style `setaf` and `setab` will support color; | ||
| if you have a color terminal that only has `setf` and `setb`, please submit | ||
| a ticket. | ||
|
|
||
| ## 24-bit Color | ||
|
|
||
| _Tcell_ _supports 24-bit color!_ (That is, if your terminal can support it.) | ||
| _Tcell_ _supports 24-bit color!_ (That is, if your terminal can support it.) | ||
|
|
||
| NOTE: Technically the approach of using 24-bit RGB values for color is more | ||
| accurately described as "direct color", but most people use the term "true color". | ||
| We follow the (inaccurate) common convention. | ||
|
|
||
| There are a few ways you can enable (or disable) true color. | ||
|
|
||
| * For many terminals, we can detect it automatically if your terminal | ||
| includes the `RGB` or `Tc` capabilities (or rather it did when the database | ||
| was updated.) | ||
| - For many terminals, we can detect it automatically if your terminal | ||
| includes the `RGB` or `Tc` capabilities (or rather it did when the database | ||
| was updated.) | ||
|
|
||
| * You can force this one by setting the `COLORTERM` environment variable to | ||
| `24-bit`, `truecolor` or `24bit`. This is the same method used | ||
| by most other terminal applications that support 24-bit color. | ||
| - You can force this one by setting the `COLORTERM` environment variable to | ||
| `24-bit`, `truecolor` or `24bit`. This is the same method used | ||
| by most other terminal applications that support 24-bit color. | ||
|
|
||
| * 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. | ||
| (This feature is deprecated. | ||
| It is recommended to use one of other methods listed above.) | ||
| - 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. | ||
| (This feature is deprecated. | ||
| It is recommended to use one of other methods listed above.) | ||
|
|
||
| * You can disable 24-bit color by setting `TCELL_TRUECOLOR=disable` in your | ||
| environment. | ||
| - You can disable 24-bit color by setting `TCELL_TRUECOLOR=disable` in your | ||
| environment. | ||
|
|
||
| When using TrueColor, programs will display the colors that the programmer | ||
| intended, overriding any "`themes`" you may have set in your terminal | ||
| emulator. (For some cases, accurate color fidelity is more important | ||
| than respecting themes. For other cases, such as typical text apps that | ||
| emulator. (For some cases, accurate color fidelity is more important | ||
| than respecting themes. For other cases, such as typical text apps that | ||
| only use a few colors, its more desirable to respect the themes that | ||
| the user has established.) | ||
|
|
||
|
|
@@ -210,7 +210,7 @@ avoiding repeated sequences or drawing the same cell on refresh updates. | |
| (Not relevant for Windows users.) | ||
|
|
||
| The Terminfo implementation operates with a built-in database. | ||
| This should satisfy most users. However, it can also (on systems | ||
| This should satisfy most users. However, it can also (on systems | ||
| with ncurses installed), dynamically parse the output from `infocmp` | ||
| for terminals it does not already know about. | ||
|
|
||
|
|
@@ -227,8 +227,8 @@ since the early 1970s. | |
|
|
||
| Mouse support is detected via the `kmous` terminfo variable, however, | ||
| enablement/disablement and decoding mouse events is done using hard coded | ||
| sequences based on the XTerm X11 model. All popular | ||
| terminals with mouse tracking support this model. (Full terminfo support | ||
| sequences based on the XTerm X11 model. All popular | ||
| terminals with mouse tracking support this model. (Full terminfo support | ||
| is not possible as terminfo sequences are not defined.) | ||
|
|
||
| On Windows, the mouse works normally. | ||
|
|
@@ -241,21 +241,21 @@ Modern _xterm_, macOS _Terminal_, and _iTerm_ all work well. | |
| ## Bracketed Paste | ||
|
|
||
| Terminals that appear to support the XTerm mouse model also can support | ||
| bracketed paste, for applications that opt-in. See `EnablePaste()` for details. | ||
| bracketed paste, for applications that opt-in. See `EnablePaste()` for details. | ||
|
|
||
| ## Testability | ||
|
|
||
| There is a `SimulationScreen`, that can be used to simulate a real screen | ||
| for automated testing. The supplied tests do this. The simulation contains | ||
| for automated testing. The supplied tests do this. The simulation contains | ||
| event delivery, screen resizing support, and capabilities to inject events | ||
| and examine "`physical`" screen contents. | ||
|
|
||
| ## Platforms | ||
|
|
||
| ### POSIX (Linux, FreeBSD, macOS, Solaris, etc.) | ||
|
|
||
| Everything works using pure Go on mainstream platforms. Some more esoteric | ||
| platforms (e.g., AIX) may need to be added. Pull requests are welcome! | ||
| Everything works using pure Go on mainstream platforms. Some more esoteric | ||
| platforms (e.g., AIX) may need to be added. Pull requests are welcome! | ||
|
|
||
| ### Windows | ||
|
|
||
|
|
@@ -268,15 +268,15 @@ support all the good features (resize, mouse tracking, etc.) | |
|
|
||
| These platforms won't work, but compilation stubs are supplied | ||
| for folks that want to include parts of this in software for those | ||
| platforms. The Simulation screen works, but as _Tcell_ doesn't know how to | ||
| platforms. The Simulation screen works, but as _Tcell_ doesn't know how to | ||
| allocate a real screen object on those platforms, `NewScreen()` will fail. | ||
|
|
||
| If anyone has wisdom about how to improve support for these, | ||
| please let me know. PRs are especially welcome. | ||
| please let me know. PRs are especially welcome. | ||
|
|
||
| ### Commercial Support | ||
|
|
||
| _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. | ||
| * [Staysail Systems Inc.](mailto:[email protected]) offers direct support, and custom development around _Tcell_ on an hourly basis. | ||
| - [TideLift](https://tidelift.com/) subscriptions include support for _Tcell_, as well as many other open source packages. | ||
| - [Staysail Systems Inc.](mailto:[email protected]) offers direct support, and custom development around _Tcell_ on an hourly basis. | ||