[README] Improve README.

This commit is contained in:
Lorenzo Cogotti 2022-08-24 15:48:07 +02:00
parent c159cb078c
commit 5b18f3da3a
1 changed files with 20 additions and 2 deletions

View File

@ -1,3 +1,21 @@
# yui-examples
Yui Examples
============
Yui library examples repository.
A collection of code examples for [Yui](https://git.doublefourteen.io/lua/yui).
## Contents
* [Hello World](examples/helloworld.lua) -- most basic of the basics.
* [Basic Menu](examples/basicmenu.lua) -- a simple menu made of buttons, useful for main menus and pause menus.
* [Options Menu](examples/optionsmenu.lua) -- comprehensive example, demonstrating several widgets and interactions.
...and the [initial selection](examples/init.lua) menu is a demo in itself :)
## Acknowledgement
Some examples use [PixelDroid Menu fonts](https://github.com/pixeldroid/fonts),
see [ACKNOWLEDGEMENT](fonts/README.ACKNOWLEDGEMENT) for details.
## License
Zlib, see [LICENSE](LICENSE) for details.