Initial commit

README.md

@@ -0,0 +1,36 @@
+# Quip
+
+Quip is a UI library that wraps around SDL3.
+
+## Building and Installing
+
+First, ensure you have SDL3, SDL3_ttf, and Noto fonts installed.
+
+On Arch Linux:
+
+```shell
+paru -S sdl3 sdl3_ttf noto-fonts
+```
+
+The following commands will build and run Quip on your system. It will be installed to /usr/local/lib and /usr/local/include.
+
+```shell
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build
+sudo cmake --install build
+```
+
+## Quickstart
+
+```c++
+#include <quip.h>
+
+int main() {
+    Quip::Window window("Quip Window", 800, 600);
+    int buttonPresses = 0;
+    window.addChild("textLabel", Quip::Widget::TextLabel("Hello from Quip!", 10, 10));
+    return window.run();
+}
+```
+
+Documentation is provided in the repository wiki.