OrgGo
/
tcell
mirror of https://github.com/gdamore/tcell.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README for new mkinfo

This commit is contained in:
Garrett D'Amore 2019-07-29 22:47:04 -07:00
parent 1922b3786e
commit fef653e8d0
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
terminfo/README.md
View File

@ -1,8 +1,25 @@
To run the database:
This package represents the parent for all terminals.
./mkinfo -all
In older versions of tcell we had (a couple of) different
external file formats for the terminal database. Those are
now removed. All terminal definitions are supplied by
one of two methods:
You can also generate a single entry:
1. Compiled Go code
./mkinfo -db <term>
2. For systems with terminfo and infocmp, dynamically
generated at runtime.
The Go code can be generated using the mkinfo utility in
this directory. The database entry should be generated
into a package in a directory named as the first character
of the package name. (This permits us to group them all
without having a huge directory of little packages.)
It may be desirable to add new packages to the extended
package, or -- rarely -- the base package.
Applications which want to have the large set of terminal
descriptions built into the binary can simply import the
extended package. Otherwise a smaller reasonable default
set (the base package) will be included instead.