aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b356638
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+libtermkit
+==========
+
+A powerful and easy to use terminal widget UI library, based on termbox.
+Provides a convenient API around event listeners, event propagation,
+widgets, menus, decorators and stylesheets.
+
+
+How to build
+------------
+
+An out-of-source build is recommended. `termbox` [0] is a build dependency.
+
+```
+$> mkdir build; cd build
+$> cmake ..
+$> make -j 2
+```
+
+[0]: https://github.com/nsf/termbox
+
+
+License
+-------
+
+This program is free software; you can redistribute it and/or modify
+
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version.
+
+I hope you enjoy ❤