doc: initial readme documentation

2024-11-09 21:47:52 +01:00
parent 4e8487353e
commit 84882d2991
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,14 @@
+# zterm Terminal User Interface Library
+
+`zterm` is a terminal user interface library to implement terminal (fullscreen or inline) applications.
+
+> [!NOTE]  
+> Currently `zig 0.13.0` is officially supported. Builds using the master version might not work.
+
+## Usage
+
+To include `zterm` as a dependency in your project run the following command:
+
+```sh
+zig fetch --save git+https://gitea.yves-biener.de/yves-biener/zterm
+```