readme and dd

This commit is contained in:
chrisbell committed 2026-11-02 23:34:26 -06:00
1 parent da7445fbc1
commit 4726254dcd
3 files changed
+70 -1

No files matched your search

+7
View File
@@ -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.
+29
View File
@@ -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
+34 -1
View File
@@ -1,2 +1,35 @@
# Regolith UI # 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