e-mission · shankari · Oct 20, 2023 · Sep 12, 2023 · Sep 23, 2023 · Sep 23, 2023
diff --git a/README.md b/README.md
@@ -3,7 +3,9 @@ e-mission phone app
 
 This is the phone component of the e-mission system.
 
-:sparkles: This has now been upgraded to cordova android@9.0.0 and iOS@6.0.1 ([details](https://github.com/e-mission/e-mission-docs/issues/554)). It has also been upgraded to [android API 29](https://github.com/e-mission/e-mission-phone/pull/707/), [cordova-lib@10.0.0 and the most recent node and npm versions](https://github.com/e-mission/e-mission-phone/pull/708)It also now supports CI, so we should not have any build issues in the future. The limitations from the [previous upgrade](https://github.com/e-mission/e-mission-docs/issues/519) have all been resolved. This should be ready to build out of the box, after all the configuration files are changed.
+:sparkles: This has been upgraded to the latest **Android**, **iOS**, **cordova-lib**, **node** and **npm** versions. __This is ready to build out of the box.__
+
+For the latest versions, refer [`package.cordovabuild.json`](package.cordovabuild.json)
 
 Additional Documentation
 ---
@@ -12,6 +14,14 @@ https://github.com/e-mission/e-mission-docs/tree/master/docs/e-mission-phone
 
 **Issues:** Since this repository is part of a larger project, all issues are tracked [in the central docs repository](https://github.com/e-mission/e-mission-docs/issues). If you have a question, [as suggested by the open source guide](https://opensource.guide/how-to-contribute/#communicating-effectively), please file an issue instead of sending an email. Since issues are public, other contributors can try to answer the question and benefit from the answer.
 
+## Contents
+#### 1. [Updating the UI only](#updating-the-ui-only)
+#### 2. [End to End Testing](#end-to-end-testing)   
+#### 3. [Updating the e-mission-* plugins or adding new plugins](#updating-the-e-mission--plugins-or-adding-new-plugins)
+#### 4. [Creating logos](#creating-logos) 
+#### 5. [Beta-testing debugging](#beta-testing-debugging) 
+#### 6. [Contributing](#contributing)
+
 Updating the UI only
 ---
 [![osx-serve-install](https://github.com/e-mission/e-mission-phone/workflows/osx-serve-install/badge.svg)](https://github.com/e-mission/e-mission-phone/actions?query=workflow%3Aosx-serve-install)
@@ -23,30 +33,30 @@ If you want to make only UI changes, (as opposed to modifying the existing plugi
 Run the setup script
 
 ```
-$ bash setup/setup_serve.sh
+bash setup/setup_serve.sh
 ```
 
 **(optional)** Configure by changing the files in `www/json`.
 Defaults are in `www/json/*.sample`
 
 ```
-$ ls www/json/*.sample
-$ cp www/json/startupConfig.json.sample www/json/startupConfig.json
-$ cp ..... www/json/connectionConfig.json
+ls www/json/*.sample
+cp www/json/startupConfig.json.sample www/json/startupConfig.json
+cp ..... www/json/connectionConfig.json
 ```
 
 ### Activation (after install, and in every new shell)
 
 ```
-$ source setup/activate_serve.sh
+source setup/activate_serve.sh
 ```
 
 ### Running
 
 1. Start the phonegap deployment server and note the URL(s) that the server is listening to.
 
     ```
-    $ npm run serve
+    npm run serve
     ....
     [phonegap] listening on 10.0.0.14:3000
     [phonegap] listening on 192.168.162.1:3000
@@ -86,6 +96,7 @@ Updating the e-mission-\* plugins or adding new plugins
 ---
 [![osx-build-ios](https://github.com/e-mission/e-mission-phone/actions/workflows/ios-build.yml/badge.svg)](https://github.com/e-mission/e-mission-phone/actions/workflows/ios-build.yml)
 [![osx-build-android](https://github.com/e-mission/e-mission-phone/actions/workflows/android-build.yml/badge.svg)](https://github.com/e-mission/e-mission-phone/actions/workflows/android-build.yml)
+[![osx-android-prereq-sdk-install](https://github.com/e-mission/e-mission-phone/actions/workflows/android-automated-sdk-install.yml/badge.svg)](https://github.com/e-mission/e-mission-phone/actions/workflows/android-automated-sdk-install.yml)
 
 Pre-requisites
 ---
@@ -94,10 +105,10 @@ Pre-requisites
     - or this [supposedly easier to use repo](https://github.com/xcpretty/xcode-install)
     - **NOTE**: the basic xcode install on Catalina was messed up for me due to a prior installation of command line tools. [These workarounds helped](https://github.com/nodejs/node-gyp/blob/master/macOS_Catalina.md).
 - git
-- Java 11. Tested with [OpenJDK 11 (Temurin) using AdoptOpenJDK](https://adoptopenjdk.net/releases.html).
+- Java 17. Tested with [OpenJDK 17 (Temurin) using Adoptium](https://adoptium.net).
 - android SDK; install manually or use setup script below. Note that you only need to run this once **per computer**.
     ```
-    $ bash setup/prereq_android_sdk_install.sh
+    bash setup/prereq_android_sdk_install.sh
     ```
 
     <details><summary>Expected output</summary>
@@ -142,26 +153,46 @@ Installing (one time only)
 Run the setup script for the platform you want to build
 
 ```
-$ bash setup/setup_android_native.sh
+bash setup/setup_android_native.sh
+```
 AND/OR
-$ bash setup/setup_ios_native.sh
+```
+bash setup/setup_ios_native.sh
 ```
 
 **(optional)** Configure by changing the files in `www/json`.
 Defaults are in `www/json/*.sample`
 
 ```
-$ ls www/json/*.sample
-$ cp www/json/startupConfig.json.sample www/json/startupConfig.json
-$ cp ..... www/json/connectionConfig.json
+ls www/json/*.sample
+cp www/json/startupConfig.json.sample www/json/startupConfig.json
+cp ..... www/json/connectionConfig.json
 ```
 
 ### Activation (after install, and in every new shell)
 
 ```
-$ source setup/activate_native.sh
+source setup/activate_native.sh
+```
+
+<details><summary> Expected Output </summary>
+
+``` 
+Activating nvm
+Using version <X version number>
+Now using node <X version number> (npm <Y version>)
+npm version = <Y version>
+Adding cocoapods to the path
+Verifying /Users/<username>/Library/Android/sk or /Users/<username>/Library/Android/sdk is set
+Activating sdkman, and by default, gradle
+Ensuring that we use the most recent version of the command line tools
+Configuring the repo for building native code
+Copied config.cordovabuild.xml -> config.xml and package.cordovabuild.json -> package.json
 ```
 
+</details>
+
+
 ### Activation (after install, and in every new shell)
 
 If connecting to a development server over http, make sure to turn on http support on android
@@ -175,10 +206,24 @@ If connecting to a development server over http, make sure to turn on http suppo
 ### Run in the emulator
 
 ```
-$ npx cordova emulate ios
+npm run <ios>
+```
 AND/OR
-$ npx cordova emulate android
 ```
+npm run <android>
+```
+for builds, refer [`package.cordovabuild.json`](package.cordovabuild.json)
+
+<details><summary>Expected output</summary>
+
+```
+BUILD SUCCESSFUL in 2m 48s
+52 actionable tasks: 52 executed
+Built the following apk(s):
+/Users/<Username>/e-mission-phone/platforms/android/app/build/outputs/apk/debug/app-debug.apk
+```
+
+</details> 
 
 Creating logos
 ---
@@ -223,28 +268,34 @@ Contributing
 
 Add the main repo as upstream
 
-    $ git remote add upstream https://github.com/covid19database/phone-app.git
+    git remote add upstream https://github.com/e-mission/e-mission-phone.git
 
 Create a new branch (IMPORTANT). Please do not submit pull requests from master
 
-    $ git checkout -b mybranch
+    git checkout -b mybranch
 
 Make changes to the branch and commit them
 
-    $ git commit
+    git commit
 
 Push the changes to your local fork
 
-    $ git push origin mybranch
+    git push origin mybranch
 
 Generate a pull request from the UI
 
 Address my review comments
 
 Once I merge the pull request, pull the changes to your fork and delete the branch
 ```
-$ git checkout master
-$ git pull upstream master
-$ git push origin master
-$ git branch -d mybranch
+git checkout master
+```
+```
+git pull upstream master
+```
+```
+git push origin master
+```
+```
+git branch -d <branch>
 ```