diff options
| author | Julian Hurst <ark@mansus.space> | 2023-09-07 00:24:14 +0200 |
|---|---|---|
| committer | Julian Hurst <ark@mansus.space> | 2023-09-11 17:16:54 +0200 |
| commit | f63591f07a53af009318aed92912739cab132b6f (patch) | |
| tree | 3fe2c92e3e23a3f8a612c56b8c64fd83e1d559f7 /README.md | |
| parent | 26bb0a3733f61659d739e50d83fdda09f452f200 (diff) | |
| download | hare-libtui-f63591f07a53af009318aed92912739cab132b6f.tar.gz | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -3,16 +3,20 @@ This package provides widgets and various functions for creating a tui (terminal user interface). +This currently mostly provides a scrollable list widget with truncated width and various functions to init the ui, print the ui, add listeners, scan a rune, suspend/resume the TUI, clear the screen, etc. + +For a messy but functional example of this library's usage see: https://git.sr.ht/~ark/ilhare + **Status**: Incomplete ## Provided modules - **libtui**: main ui functions and initialization - **libtui::layout**: common functions for widget containers -- **libtui::vlayout**: widget container focused on vertical layouts +- **libtui::vlayout**: widget container focused on vertical layouts (incomplete, untested) - **libtui::widget**: common functions and types for all widgets - **libtui::widget::list**: scrollable width-truncated list widget with relevant functions for navigation and selection -- **libtui::widget::ed**: a text editor widget +- **libtui::widget::ed**: a text editor widget (incomplete, untested) ## Dependencies @@ -27,6 +31,12 @@ This package provides widgets and various functions for creating a tui make install ``` +To generate html docs: + +``` +make docs +``` + ### Vendoring ``` |