Update README.md
This commit is contained in:
parent
808dc98488
commit
e0d40b2fc2
1 changed files with 16 additions and 2 deletions
18
README.md
18
README.md
|
@ -1,5 +1,19 @@
|
|||
# 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.
|
||||
|
||||

|
Loading…
Add table
Reference in a new issue