From 5b18f3da3ad69b75f11ca1dd62c8874f4b1e8c7e Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Wed, 24 Aug 2022 15:48:07 +0200 Subject: [PATCH] [README] Improve README. --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ac42d2..ad1754d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# yui-examples +Yui Examples +============ -Yui library examples repository. \ No newline at end of file +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.