From 4726254dcd021741f3ffe59f2f61b94972702195 Mon Sep 17 00:00:00 2001
From: chris bell <chrisbell@bellsworne.com>
Date: Mon, 2 Nov 2026 23:34:26 -0600
Subject: [PATCH] readme and dd

---
 LICENSE.txt        |  7 +++++++
 docs/design-doc.md | 29 +++++++++++++++++++++++++++++
 readme.md          | 35 ++++++++++++++++++++++++++++++++++-
 3 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 LICENSE.txt
 create mode 100644 docs/design-doc.md

diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..a8a89fa
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright (c) 2026 Bellsworne LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/docs/design-doc.md b/docs/design-doc.md
new file mode 100644
index 0000000..3ed3d86
--- /dev/null
+++ b/docs/design-doc.md
@@ -0,0 +1,29 @@
+# Regolith: A retained-mode GUI framework built with C on top of Clay
+
+## Status
+
+
+## Goals
+### Primary
+- Retained mode
+  - State management
+  - Data binding
+- Easy initalizaion
+- Clean C API for creating bindings for other langs
+- Renderer and backend agnostic
+- Clay as the layout engine (Flexbox style with transitions support)
+- Extensive Lua integration for both UI documents AND logic (totally optional, you can create the whole UI tree with the C API)
+- Useful for both desktop applications and game UIs
+
+### Future 
+- IME support
+- Accessibility support (Screen readers, etc)
+- WASM support
+- Official Odin bindings
+
+### Fever dream
+- Android and iOS support
+- Embedded devices support
+
+## Implementation details
+
diff --git a/readme.md b/readme.md
index c290349..85ba37e 100644
--- a/readme.md
+++ b/readme.md
@@ -1,2 +1,35 @@
 # Regolith UI
-A NATIVE retained-mode GUI framework written in C 
+A native retained-mode GUI framework written in C, built on top of Clay (https://github.com/nicbarker/clay)
+
+# *THIS PROJECT IS A WIP*
+
+## Looking for contributors!
+I am looking for people who think this is a great project idea and wish to help build it, without the use of LLMs. My graphics programming knowledge is basically zero, so that is a pain point. 
+
+## Status
+Currently in the design phase
+
+## Goals
+### Primary
+- Retained mode
+  - State management
+  - Data binding
+- Easy initalizaion
+- Clean C API for creating bindings for other langs
+- Renderer and backend agnostic
+- Clay as the layout engine (Flexbox style with transitions support)
+- Extensive Lua integration for both UI documents AND logic (totally optional, you can create the whole UI tree with the C API)
+- Useful for both desktop applications and game UIs
+
+### Future 
+- IME support
+- Accessibility support (Screen readers, etc)
+- WASM support
+- Official Odin bindings
+
+### Fever dream
+- Android and iOS support
+- Embedded devices support
+
+## Implementation details
+