From c36bd7f97f7b89c2d7445a62255686f399333ed7 Mon Sep 17 00:00:00 2001
From: Gordon Williams <gw@pur3.co.uk>
Date: Thu, 23 Apr 2020 10:57:59 +0100
Subject: [PATCH] Add readme to example apps (fix #300)

---
 apps/_example_app/README.md           | 25 +++++++++++++++++++++++++
 apps/_example_app/add_to_apps.json    |  1 +
 apps/_example_widget/README.md        | 25 +++++++++++++++++++++++++
 apps/_example_widget/add_to_apps.json |  1 +
 4 files changed, 52 insertions(+)
 create mode 100644 apps/_example_app/README.md
 create mode 100644 apps/_example_widget/README.md

diff --git a/apps/_example_app/README.md b/apps/_example_app/README.md
new file mode 100644
index 000000000..dc139bc9a
--- /dev/null
+++ b/apps/_example_app/README.md
@@ -0,0 +1,25 @@
+# App Name
+
+Describe the app...
+
+Add screen shots (if possible) to the app folder and link then into this file with ![](<name>.png)
+
+## Usage
+
+Describe how to use it
+
+## Features
+
+Name the function
+
+## Controls
+
+Name the buttons and what they are used for
+
+## Requests
+
+Name who should be contacted for support/update requests
+
+## Creator
+
+Your name
diff --git a/apps/_example_app/add_to_apps.json b/apps/_example_app/add_to_apps.json
index ca75a7bd8..bb0377b66 100644
--- a/apps/_example_app/add_to_apps.json
+++ b/apps/_example_app/add_to_apps.json
@@ -6,6 +6,7 @@
   "version":"0.01",
   "description": "A detailed description of my great app",
   "tags": "",
+  "readme": "README.md",
   "storage": [
     {"name":"7chname.app.js","url":"app.js"},
     {"name":"7chname.img","url":"app-icon.js","evaluate":true}
diff --git a/apps/_example_widget/README.md b/apps/_example_widget/README.md
new file mode 100644
index 000000000..a909e9e7e
--- /dev/null
+++ b/apps/_example_widget/README.md
@@ -0,0 +1,25 @@
+# Widget Name
+
+Describe the app...
+
+Add screen shots (if possible) to the app folder and link then  into this file with ![](<name>.png)
+
+## Usage
+
+Describe how to use it
+
+## Features
+
+Name the function
+
+## Controls
+
+Name the buttons and what they are used for
+
+## Requests
+
+Name who should be contacted for support/update requests
+
+## Creator
+
+Your name
diff --git a/apps/_example_widget/add_to_apps.json b/apps/_example_widget/add_to_apps.json
index 5d0057960..527c698a0 100644
--- a/apps/_example_widget/add_to_apps.json
+++ b/apps/_example_widget/add_to_apps.json
@@ -7,6 +7,7 @@
   "description": "A detailed description of my great widget",
   "tags": "widget",
   "type": "widget",
+  "readme": "README.md",
   "storage": [
     {"name":"7chname.wid.js","url":"widget.js"}
   ]