From 4cf998a547800915a01fc3360c25307389a7b0d5 Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Wed, 24 Aug 2022 19:23:32 +0200 Subject: [PATCH] [README] Add instructions for running the demos. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a14832..8f0ece8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Yui Examples ============ -A collection of code examples for [Yui](https://git.doublefourteen.io/lua/yui). +A collection of code examples for [yui](https://git.doublefourteen.io/lua/yui). ## Contents @@ -11,6 +11,20 @@ A collection of code examples for [Yui](https://git.doublefourteen.io/lua/yui). ...and the [initial selection](examples/init.lua) menu is a demo in itself :) +## Running the examples + +1. Clone this repository. + +2. Download **yui** and its dependencies using [crush](https://git.doublefourteen.io/lua/crush): + ```sh + lua crush.lua + ``` + +3. Start the demo menu with [LÖVE](https://love2d.org): + ```sh + love . + ``` + ## Acknowledgement Some examples use [PixelDroid Menu fonts](https://github.com/pixeldroid/fonts),