Merge branch 'main' of ssh://code.booklordofthe.dev:2003/Theater/TheaterGui

LICENSE

@@ -0,0 +1,11 @@
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright (c) 2024, Booklordofthedings.
+
+All rights reserved.
+
+Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+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 OF THIRD PARTY RIGHTS. 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.
+
+Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.

README.md

@@ -1,5 +1,21 @@
-# TheaterGui - *A simple ui library*
+# TheaterGui
 
-__Visit the wiki tab to get information on how to get started or on how this library works internally__
+TheaterGui is a simple to use UI library for my engine and for the creation of gui tools.  
+It can also be embedded into an existing raylib application and can be build for Wasm aswell.  
+Its written in *Beef* and is intended to be used in *Beef*.  
+Usage in other programming languages might be hard.
 
+## Installation
+- Install the [raylib-beef](https://code.booklordofthe.dev/Extern/raylib-beef) library by Starpelly. Either from this website or from the original Github page.
+- Download or clone the code from this repository or from the releases tab.
+- Add the project as a dependency of your own project.
+- Start by using the generator to generate a Screen class
+- Call TheaterGui.App.Run 
+
+## Usage
+Simply inherit from the component you want to create and add a new instance of your class to the current Screen.  
+Looking at the example code should explain some things.
+
+
+## Example
 ![Image](/example.png)