summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b0386bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# DUCK Hy Proof-of-Concept
+
+Proof of concept for creating an Android app with
+[Hy](http://docs.hylang.org/en/stable/) and David Boddie's
+[DUCK](http://www.boddie.org.uk/david/Projects/Python/DUCK/README.html).
+
+## Building
+
+Begin by following the directions listed in the ['Getting
+Started'](http://www.boddie.org.uk/david/Projects/Python/DUCK/Documents/Getting_Started.html)
+section of DUCK's documentation. Now, install the latest version of Hy:
+
+```sh
+$ pip install git+https://github.com/hylang/hy.git
+```
+
+The build script should now work.
+
+```sh
+$ hy build.hy <key file> <certificate file> out.apk
+```