diff --git a/README.md b/README.md new file mode 100644 index 0000000..83e9ad9 --- /dev/null +++ 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 +```