add readme

This commit is contained in:
opFez 2021-03-05 14:29:07 +01:00
parent fe829177ee
commit 4db2847f8e
2 changed files with 4 additions and 1 deletions

3
readme Normal file
View File

@ -0,0 +1,3 @@
tui-lib is a library for creating TUI applications, in similar vein to ncurses.
It was made for personal use, but should work for others as well.
The tui.h file provides documentation for the different structs and functions.

2
tui.h
View File

@ -96,7 +96,7 @@ struct cell_buffer {
int width;
};
/* Return type of polling events.
/* Return type of polling/peeking events.
* The prefix field will be filled with an eventual ^[ (escape key hit). This
* happens if inputting the alt-key as a modifier. This unfortunately means you
* have to hit the escape key two times to register the escape key by itself.