From 6dacbe5a115c12081ae67854d87f5bac3786a6ca Mon Sep 17 00:00:00 2001
From: lks <technolucas@protonmail.com>
Date: Thu, 25 Apr 2024 15:58:27 -0400
Subject: [PATCH] add README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index e69de29..cdd4940 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,25 @@
+# Android eframe template
+A basic eframe template with android support.
+
+## Compile for Desktop
+Run cargo as normal
+```
+cargo build
+```
+
+## Compile for Web
+use [Trunk](https://trunkrs.dev/#install).
+```
+trunk build
+```
+
+## Compile for Android
+use [xbuild](https://github.com/rust-mobile/xbuild).
+```
+x build --platform android --arch arm64
+```
+
+If this fails check that you have the required external build tools installed with
+```
+x doctor
+```