From 01294425131877c19d9724d608ec3384ca34297c Mon Sep 17 00:00:00 2001
From: Justin Moon <mail@justinmoon.com>
Date: Fri, 15 May 2020 05:54:31 -0500
Subject: [PATCH] Explain that example runs in a simulator (#4)

* Add README to 'demo' example

* Explain that demo runs in simulator
---
 README.md               |  3 +++
 examples/demo/README.md | 12 ++++++++++++
 2 files changed, 15 insertions(+)
 create mode 100644 examples/demo/README.md

diff --git a/README.md b/README.md
index 7ac4dab..e8b7c43 100644
--- a/README.md
+++ b/README.md
@@ -37,3 +37,6 @@ We recommend the `lv_conf.h` file to be in your project's root directory. If so,
 $ DEP_LV_CONFIG_PATH=`pwd` cargo build
 ```
 
+## Running the demo
+
+[This project contains an example that can run in a desktop simulator.](./examples/demo)
diff --git a/examples/demo/README.md b/examples/demo/README.md
new file mode 100644
index 0000000..0ce3e64
--- /dev/null
+++ b/examples/demo/README.md
@@ -0,0 +1,12 @@
+From base of the repository, install LVGL git submodule.
+
+```
+git submodule update --init
+```
+
+Run this demo:
+
+```
+cd examples/demo/
+DEP_LV_CONFIG_PATH=./include cargo run
+```