Added initial readme for Android Assistant app (#1667)

* Virtual Assistant Client for Android - initial public commit

* updated .gitignore to ensure the /src/debug folder is not ignored

* implemented feedback from PR 1493

* code cleanup after merge

* fixes possible exception due to race condition

* fix: release created and stopped audio records

* added timeout event so that client app can notify user

* WIP adaptive card click events

* WIP adaptive card clicking

* finished implementation of adaptive card clicking

* Updated Location event so that the data is consumed properly

* additional IPA -> VA changes

* logcat logging of complete JSON data

* using suggested actions for adaptive card click

* undo incorrect commit

* added suggested actions feature

* updates to allow the service to receive connections from other apps

* small code updates + locationProvider threading fix

* finished feature to broadcast data to other apps

* added initial readme for Android app

* Update readme.md

solutions/android/VirtualAssistantClient/readme.md

@@ -1,3 +1,72 @@
 # Virtual Assistant Android Client Application
 
-## Coming Soon
+## Building the Project
+
+### Prerequisites
+
+- [Create a Virtual Assistant](/docs/tutorials/csharp/virtualassistant.md) to setup your environment.
+
+### Step 1 - Credentials
+
+Edit `DefaultConfiguration.java` to provide the Speech Cognitive Service key, Speech Channel Secret and UserId which will be used to perform speech operations and identify the user uniquely. Note that there are two versions, one for debug and one for release build flavors.
+
+The [Speech enabling your Virtual Assistant](https://github.com/microsoft/botframework-solutions/blob/master/docs/howto/assistant/csharp/speechenablement.md) documentation covers the following two steps which you must perform to retrieve the Speech Cognitive Service Key and Speech Channel secret.
+
+- [Create a Speech Cognitive Service Key](https://github.com/microsoft/botframework-solutions/blob/master/docs/howto/assistant/csharp/speechenablement.md#create-a-microsoft-speech-instance)
+- [Add the Speech Channel to your assistant](https://github.com/microsoft/botframework-solutions/blob/master/docs/howto/assistant/csharp/speechenablement.md#add-the-speech-channel-to-your-assistant)
+
+The UserId is a unique identifier for all messages generated by the user, this is typically combind with [Linked Accounts](https://github.com/microsoft/botframework-solutions/blob/master/docs/howto/assistant/linkedaccounts.md).
+
+### Step 2 - Deploy
+1. Select the desired build flavor (debug or release)
+2. Deploy to emulator or device
+
+## Using the Project
+### Running for First Time
+- Accept the Record Audio permission to make voice requests from the bot. Without this permission, the user can only type requests to the Bot.
+- Accept the Fine Location permission to easily make voice requests that are related to your GPS location, such as "find the nearest coffee shop". Without this permission, the user will be asked by the Bot to provide the current location.
+- Slide away the service notification
+
+### The UI
+1. The Mic button is the only graphic immediately visible - press it to make a voice request. (The app will sense when you've finished speaking)
+
+2. The Navigation Drawer (on the left side of the screen) provides the following functionality:
+- Bot Configuration
+- App Configuration
+- Reset Bot
+- Send Location Event
+- Send Welcome Event
+- Inject Adaptive Card Event
+- Show Assistant Settings
+- Show Textinput
+
+### Functionality Overview
+#### Bot Configuration
+The data on this screen is originally read from "DefaultConfiguration.java". Changing the values on this screen will update the stored data and used immediately.
+NOTE: the stored data persists between app installs
+
+#### App Configuration
+Settings that are specific to the app can be set here
+
+#### Reset Bot
+If the bot enters a problematic state, you can reset it.
+
+#### Send Location Event
+Send a location event using the latitude and longitude values found in the "DefaultConfiguration.java"
+
+#### Send Welcome Event
+Triggers the Bot to respond with a default "Welcome" card
+
+#### Inject Adaptive Card Event
+To test rendering of an Adaptive Card. First, create the adaptive card Json at [Adaptive Cards Designer](https://adaptivecards.io/designer/ "Adaptive Cards Designer").
+Second, copy the generated Json into MainActivity.onNavigationItemSelected().
+Finally run the app and "inject" the adaptive card to see what it looks like when sent by the Bot.
+
+#### Show Assistant Settings
+Shortcut to the Android Assistant Settings
+
+#### Show Textinput
+Shows the text input field to make requests without needing to speak
+
+
+