From f63591f07a53af009318aed92912739cab132b6f Mon Sep 17 00:00:00 2001 From: Julian Hurst Date: Thu, 7 Sep 2023 00:24:14 +0200 Subject: Update README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42f6973..bb804d5 100644 --- a/README.md +++ b/README.md @@ -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 ``` -- cgit v1.2.3