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

Updated Introduction (markdown)

Jakub Sobon 2019-02-24 00:10:16 -05:00
parent 21a28912bb
commit 4172b1daf7
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Introduction.md

@ -8,3 +8,18 @@ Developers interact with the following Termdash layers:
- The container in the [container](https://github.com/mum4k/termdash/tree/master/container/container.go) package.
- The widgets in the [widgets/](https://github.com/mum4k/termdash/tree/master/widgets) directory.
## The infrastructure
The infrastructure allows the developer to choose how often will the terminal redraw, how any runtime errors will be processed. It also enabled the developer to subscribe to keyboard and mouse events.
## The container
The container is used to split the raw terminal into smaller portions (containers) and manage the layout of the screen. Individual containers can contain widgets, have borders and track keyboard focus.
## The widgets
The widgets are the interactive elements of Termdash, they can display data, show progress or accept input from the end-user.
## More resources
Refer to the API reference or the Examples to learn more.