From fef653e8d0c9e734b4efe51269dc2cc5d58c8728 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 29 Jul 2019 22:47:04 -0700 Subject: [PATCH] Update README for new mkinfo --- terminfo/README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/terminfo/README.md b/terminfo/README.md index b333701..20ae937 100644 --- a/terminfo/README.md +++ b/terminfo/README.md @@ -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 +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.