diff --git a/Home.md b/Home.md index 636e05b..e580d1e 100644 --- a/Home.md +++ b/Home.md @@ -3,6 +3,19 @@ It currently uses a **raylib based rendering backend** and as such is **technically platform indipendent.** However most of the testing is only done in a windows enviroment and development of programs using this library relies on the **BeefIDE code generation** feature which currently is not available on Linux. +### Getting started +- Install BeefBuild and the BeefIDE +- Download the [Raylib-Beef bindings](https://code.booklordofthe.dev/Extern/raylib-beef) by [Starpelly](https://github.com/Starpelly) and install them in your BeefLibs folder +- Download this TheaterGui library +- Create a new Beef project and add TheaterGui to its dependencies +- Generate a new Screen Component using the coresponding "New File" generator +- Before calling _TheaterGui.App.Start()_ you also need to call _TheaterGui.App.Initialize()_ and afterwards call _TheaterGui.App.Deinitialize()_ +- Create and add further components using the code generator + +### Components +This is a list of all currently available build in components, you may create new ones for your project as you please. +For additional information on each component visit their respective wiki page. + ### Theming Theming is not a goal for this library and as such is **not really officially supported.** Hover since **Beef** has very easy ways to extend or overwrite library functionality you can still do theming,