Add README.md

2024-12-03 17:02:54 +01:00 · 2024-12-03 17:02:54 +01:00 · 243f70c340
commit 243f70c340
parent 0ee98e401a
1 changed files with 24 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,24 @@
+# libscgui — Simple C++ SDL2-wrapper
+
+Rudimentary app and window support, with global and per-window event handling.
+
+## Build
+
+`make`
+
+after building and installing dependencies:
+
+- SDL2
+- SDL2_image
+
+## Install
+
+`sudo make install`
+
+or, on OpenBSD:
+
+`doas gmake install`
+
+## Documentation
+
+Not yet available.