[README] Add instructions for running the demos.

master
Lorenzo Cogotti 2 years ago
parent 599f00b13f
commit 4cf998a547

@ -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),

Loading…
Cancel
Save