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 17:03:36 -05:00
parent 5305a785d5
commit bb69a0261d
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Introduction.md

@ -9,13 +9,20 @@ 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.
Additionally some data only types are defined in in the following packages:
- The [align](https://github.com/mum4k/termdash/blob/master/align/align.go) package which defines forms of alignment.
- The [cell](https://github.com/mum4k/termdash/blob/master/cell/cell.go) package which defines universal options for terminal cells.
- The [keyboard](https://github.com/mum4k/termdash/blob/master/keyboard/keyboard.go) package which defines keyboard keys.
- The [mouse](https://github.com/mum4k/termdash/blob/master/mouse/mouse.go) package which defines mouse buttons.
## The terminal
The terminal directory contains terminal drivers, i.e. libraries that expose a cell view of the terminal. This is separately exposed so that multiple implementations are possible.
## 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 infrastructure allows the developer to start and stop the application, choose how often will the screen redraw, how to respond to runtime errors. It also enabled the developer to subscribe to keyboard and mouse events.
## The container
@ -23,8 +30,8 @@ The container is used to split the raw terminal into smaller portions (container
## The widgets
The widgets are the interactive elements of Termdash, they can display data, show progress or accept input from the end-user.
Termdash comes with a library of widgets, they can display data, show progress or accept input from the end-user.
## More resources
Refer to the [[API reference|api-reference]] or the [[Examples|examples]] to learn more.
Refer to the [[API Documentation|api-documentation]] or the [[Examples|examples]] to learn more.