add readme, dev shell, build script

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5405eff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# c3term
+
+eventually a terminal emulator, currently a port of [this example](https://github.com/ColleagueRiley/RSGL/blob/main/examples/basics/basic.c)
+
+## with nix
+
+`nix run` to run
+
+`nix develop` for a development shell, then follow the manual build instructions
+
+## manual build
+
+required by `get_wl.sh`:
+- pkg-config
+- wayland-protocols
+- wayland-scanner
+
+see `project.json` for library requirements
+
+```bash
+./get_wl.sh
+c3c build c3term-linux-x64
+```