From c7d72a9e92327f3e21094f13369ebb00905a13a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Behmo?= <regis@behmo.com>
Date: Tue, 18 May 2021 09:45:05 +0200
Subject: [PATCH] fix: README and config folder

---
 README.rst                                    | 48 +++++++++++++++++--
 .../local-docker-compose-jobs-services        |  2 +-
 2 files changed, 44 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index 302c2f1..fb39797 100644
--- a/README.rst
+++ b/README.rst
@@ -1,22 +1,60 @@
-android plugin for `Tutor <https://docs.tutor.overhang.io>`__
-===================================================================================
+Android application plugin for `Tutor <https://docs.tutor.overhang.io>`__
+=========================================================================
+
+This is a plugin to easily build an Android mobile application for your `Open edX <https://open.edx.org>`__ instance.
 
 Installation
 ------------
 
 ::
 
-    pip install git+https://github.com/overhangio/tutor-android
+    pip install tutor-android
 
 Usage
 -----
 
-::
+Enable the plugin::
 
     tutor plugins enable android
 
+To build the application in debug mode, run::
+
+    tutor android build debug
+
+The ``.apk`` file will then be available in ``$(tutor config printroot)/data/android``. Transfer it to an Android phone to install the application. You should be able to sign in and view available courses.
+
+Building a custom Android app
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Android app is built from the `official edx-app-android repository <https://github.com/edx/edx-app-android/>`__. To change this repository or the app version, you can simply build a different docker image with::
+
+    tutor images build \
+        --build-arg ANDROID_APP_REPOSITORY=https://github.com/mycustomfork/edx-app-android \
+        --build-arg ANDROID_APP_VERSION=master \
+        android
+
+Releasing an Android app
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Note**: this is an untested feature.
+
+Releasing an Android app on the Play Store requires to build the app in release mode. To do so, edit the ``$TUTOR_ROOT/config.yml`` configuration file and define the following variables::
+
+    ANDROID_RELEASE_STORE_PASSWORD
+    ANDROID_RELEASE_KEY_PASSWORD
+    ANDROID_RELEASE_KEY_ALIAS
+
+Then, place your keystore file in ``$(tutor config printroot)/env/plugins/android/apps/app.keystore``. Finally, build the application with::
+
+    tutor android build release
+
+Customising the Android app
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Customising the application, such as the logo or the background image, is currently not supported. If you are interested by this feature, please tell us about it in the Tutor `discussion forums <https://discuss.overhang.io>`_.
+
 
 License
 -------
 
-This software is licensed under the terms of the AGPLv3.
\ No newline at end of file
+This software is licensed under the terms of the AGPLv3.
diff --git a/tutorandroid/patches/local-docker-compose-jobs-services b/tutorandroid/patches/local-docker-compose-jobs-services
index cc6669a..0d05b18 100644
--- a/tutorandroid/patches/local-docker-compose-jobs-services
+++ b/tutorandroid/patches/local-docker-compose-jobs-services
@@ -1,5 +1,5 @@
 android-job:
   image: {{ ANDROID_DOCKER_IMAGE }}
   volumes:
-    - "../android/:/openedx/config/"
+    - "../plugins/android/apps:/openedx/config/"
     - "../../data/android/:/openedx/data/"