diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..68940d9 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# hare-libtui + +This package provides widgets and various functions for creating a tui +(terminal user interface). + +**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::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 + +## Dependencies + +- [hare-wcwidth][https://git.sr.ht/~ark/hare-wcwidth] +- [hare-set][https://git.sr.ht/~ark/hare-set] + +## Installation + +### System-wide installation + +``` +make install +``` + +### Vendoring + +``` +git subtree -P vendor/hare-libtui/ add https://git.sr.ht/~ark/hare-libtui master +``` |