Merge pull request #1 from Microsoft/lightfrenzy-readme

Updated ReadMe & Contributing

CONTRIBUTING.md

@@ -1,18 +1,14 @@
-Contributing to Microsoft Cognitive Services Client Libraries
+Contributing to Microsoft Cognitive Services Client Libraries & Samples
 ===============================================
-
-So, you want to contribute on a client SDK for one of the Microsoft Cognitive Services.
+So, you want to contribute on a client library or sample for one of the Microsoft Cognitive Services.
 Here's what you need to know.
 
-1.  Each SDK must include both a client library and a sample showing the API in
+1.  Each SDK should include both a client library and a sample showing the API in
     action
 
-2.  When building an SDK, it's important you support the most common development
-    platforms and that we are consistent from project to project. We require you
-    to build the following, using the associated coding guidelines, in priority
-    order:
+2.  When working on an SDK, it's important that we are consistent from project to project, so we ask you to follow the coding guidelines below:
 
-    -   .NET (Coding guidelines below)
+    -   Windows [(Coding guidelines for C#)](https://msdn.microsoft.com/en-us/library/ff926074.aspx) -- also reference our [common Windows code](https://github.com/Microsoft/Cognitive-common-windows) for building samples
 
     -   Android [(Coding guidelines for
         Java)](<http://source.android.com/source/code-style.html>)
@@ -26,29 +22,24 @@ Here's what you need to know.
 3.  Samples are important for illustrating how to actually call into the API.
     Samples should be as visual and reusable as possible.
 
-    Do:
+    - Do:
 
-    -   Create a UI sample when possible.
+        -   Create a UI sample when possible.
 
-    -   Make your sample user friendly. Expect that developers will want to try
+        -   Make your sample user friendly. Expect that developers will want to try
         different mainline scenarios and key APIs.
 
-    -   Create code that's easy for other developers to copy/paste into their
+        -   Create code that's easy for other developers to copy/paste into their
         own solutions
 
-    Consider:
+    - Consider:
 
-    -   Adding UI to allow devs to quickly copy/paste subscription keys, instead
+        -   Adding UI to allow devs to quickly copy/paste subscription keys, instead
         of updating them in the code or using a config file. The
         FaceAPI-WPF-Samples.sln provides an example.
 
-    Don't:
-
-    -   Leave your subscription key in the source of samples. You do not want
-        your key to be abused by others.
+    - Don't:
 
-4.  Always create a README.md for your top-level API root and for each platform.
+        -   Leave your subscription key in the source of samples. You do not want your key to be abused by others.
 
-    -   Use the existing README.md files as a reference for what information is
-        useful here. In general, you want to describe the functionality of the
-        API as well as specifics for how to build and run the project(s).
+Happy coding!

README.md

@@ -1,37 +1,52 @@
-Microsoft Cognitive Services Text-to-Speech client SDK and samples
-==================================================
+# Microsoft Bing Speech API: Text-to-Speech Samples
+This repo contains sample in various languages for using Text-to-Speech in the Microsoft Bing Speech API, an offering within [Microsoft Cognitive Services](https://www.microsoft.com/cognitive-services), formerly known as Project Oxford.
+* [Learn about the Bing Speech API](https://www.microsoft.com/cognitive-services/en-us/speech-api)
+* [Read the documentation](https://www.microsoft.com/cognitive-services/en-us/speech-api/documentation/overview)
+* [Find more SDKs & Samples](https://www.microsoft.com/cognitive-services/en-us/SDK-Sample?api=bing%20speech)
 
-This repo contains the client libraries that demonstrate Microsoft’s algorithms
-to generate spoken language. With this APIs developers can easily convert text
-to spoken audio. When applications need to “talk” back to their users, this API
-can be used to convert text that is generated by the app into audio that can be
-played back to the user. See the tech in action on [our demo
-page](<https://www.microsoft.com/cognitive-services/en-us/speech-api>) or learn more about the API
-with [our documentation](<https://www.projectoxford.ai/doc/speech/overview>).
 
-Getting started
-===============
+## The Sample
 
-To get started, select the platform for which you're developing.
+### Requirements
+ * Android OS must be Android 4.1 or higher (API Level 16 or higher)
+ * The speech client library contains native code. To use this sample in an emulator, make sure that your build variant matches the architecture (x86 or arm) of your emulator. However, due to the need of audio, using a physical device is recommended.
 
--   [Android](</Android/>)
+### Build the sample
+1.  First, you must obtain a Speech API subscription key by [following the instructions on our website](<https://www.microsoft.com/cognitive-services/en-us/sign-up>).
 
--   [Http samples](</Samples-Http/>)
+2.  Start Android Studio and open project by File \> Import Project. Choose subfolder "Sample" in the Speech \> TextToSpeech \> Android folder.
 
-Contributing
-============
-We welcome contributions and are always looking for new SDKs, input, and
-suggestions. Feel free to file issues on the repo and we'll address them as we can. You can also learn more about how you can help on the [Contribution
-Rules & Guidelines](</CONTRIBUTING.md>).
+3.  In Android Studio -\> "Project" panel -\> "Android" view, open file
+    "app/res/values/strings.xml", and find the line
+    "Please\_add\_the\_subscription\_key\_here;". Replace the
+    "Please\_add\_the\_subscription\_key\_here" value with your subscription key
+    string from the first step. If you cannot find the file "string.xml", it is
+    in folder "Sample\app\src\main\res\values\string.xml".
 
-For questions, feedback, or suggestions about Microsoft Cognitive Services, feel free to reach out to us directly.
+4.  In Android Studio, select menu "Build \> Make Project" to build the sample, and "Run" to launch this sample app.
 
--   [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)
+### Run the sample
+In Android Studio, select menu "Run", and "Run app" to launch this sample app.
 
-License
-=======
+<img src="SampleScreenshots/SampleRunning1.png" width="50%"/>
 
+
+## Contributing
+We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our [Contribution Rules & Guidelines](</CONTRIBUTING.md>). 
+
+You can reach out to us anytime with questions and suggestions using our communities below:
+ - **Support questions:** [StackOverflow](<https://stackoverflow.com/questions/tagged/microsoft-cognitive>)
+ - **Feedback & feature requests:** [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+
+## License
 All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see
 [LICENSE](</LICENSE.md>).
 
 Sample images are licensed separately, please refer to [LICENSE-IMAGE](</LICENSE-IMAGE.md>).
+
+
+## Developer Code of Conduct
+Developers using Cognitive Services, including this client library & sample, are expected to follow the “Developer Code of Conduct for Microsoft Cognitive Services”, found at [http://go.microsoft.com/fwlink/?LinkId=698895](http://go.microsoft.com/fwlink/?LinkId=698895).