From 3af37951fc0fb7f5476a40591eb56c71e1ce0eb7 Mon Sep 17 00:00:00 2001
From: Thibault Deckers <thibault.deckers@gmail.com>
Date: Sat, 20 Jun 2020 18:37:52 +0900
Subject: [PATCH] added project setup instructions

---
 README.md                       | 5 ++++-
 android/key_template.properties | 5 +++++
 2 files changed, 9 insertions(+), 1 deletion(-)
 create mode 100644 android/key_template.properties

diff --git a/README.md b/README.md
index 1723a7a3c..e8316e1fa 100644
--- a/README.md
+++ b/README.md
@@ -27,10 +27,13 @@ If time permits, I intend to eventually add these:
 - support: Android R
 - subsampling/tiling
 
-## Known issues
+## Known Issues
 - privacy: cannot opt out of Crashlytics reporting (cf [flutterfire issue #1143](https://github.com/FirebaseExtended/flutterfire/issues/1143))
 - gesture: double tap on image does not zoom on tapped area (cf [photo_view issue #82](https://github.com/renancaraujo/photo_view/issues/82))
 - performance: image info page stutters the first time it loads a Google Maps view (cf [flutter issue #28493](https://github.com/flutter/flutter/issues/28493))
 - performance: image decoding is slow
 
+## Project Setup
+Create a file named `<app dir>/android/key.properties`. It should contain a reference to a keystore for app signing, and other necessary credentials. See `<app dir>/android/key_template.properties` for the expected keys.
+
 [Aves logo]: https://github.com/deckerst/aves/blob/master/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
diff --git a/android/key_template.properties b/android/key_template.properties
new file mode 100644
index 000000000..e335f59b6
--- /dev/null
+++ b/android/key_template.properties
@@ -0,0 +1,5 @@
+storeFile=<KEYSTORE_PATH>
+storePassword=<KEYSTORE_PASSWORD>
+keyAlias=<KEY_ALIAS>
+keyPassword=<KEY_PASSWORD>
+googleApiKey=<GOOGLE_API_KEY>