aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 42f69738d0a6980abc10e4e74831deb79329468e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
```