readme update

toshish · Jun 3, 2019 · e24fa89 · e24fa89
1 parent 25b37ba
commit e24fa89
Show file tree

Hide file tree

Showing 21 changed files with 377 additions and 128 deletions.
diff --git a/Group-Video/OpenVideoCall-Android/README.md b/Group-Video/OpenVideoCall-Android/README.md
@@ -27,8 +27,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Update "app/src/main/res/values/strings_config.xml" with your App ID.
@@ -38,25 +38,30 @@ To build and run the sample application, get an App ID:
 
 ### Integrate the Agora Video SDK
 
-There are two ways to integrate:
-- The recommended way to integrate:
-  - Add the address which can integrate the Agora Video SDK automatically through JCenter in the property of the dependence of the `app/build.gradle`:
-
-    ```
-    implementation 'io.agora.rtc:full-sdk:2.4.0'
-    ```
-    (Adding the link address is the most important step if you want to integrate the Agora Video SDK in your own application.)
-  
-  - Download the **Agora Video SDK** from [Agora.io SDK](https://www.agora.io/en/download/). Unzip the downloaded SDK package and copy ***.h** under **libs/include** to **app/src/main/cpp/agora**.
-- Alternative way to integrate:
-  
-  - Download the **Agora Video SDK** from [Agora.io SDK](https://www.agora.io/en/download/). Unzip the downloaded SDK package and copy ***.jar** under **libs** to **app/libs**, **arm64-v8a**/**x86**/**armeabi-v7a** under **libs** to **app/src/main/jniLibs**, ***.h** under **libs/include** to **app/src/main/cpp/agora**.
-  
-  - Add the following code in the property of the dependence of the `app/build.gradle`:
-  
-    ```
-    compile fileTree(dir: 'libs', include: ['*.jar'])
-    ```
+The SDK must be integrated into the sample project before it can opened and built. There are two methods for integrating the Agora Video SDK into the sample project. The first method uses JCenter to automatically integrate the SDK files. The second method requires you to manually copy the SDK files to the project.
+
+#### Method 1 - Integrate the SDK Automatically Using JCenter (Recommended)
+
+1. Clone this repository.
+2. Open **app/build.gradle** and add the following line to the `dependencies` list:
+
+  ```
+  ...
+  dependencies {
+      ...
+      implementation 'io.agora.rtc:full-sdk:2.4.0'
+  }
+  ```
+
+#### Method 2 - Manually copy the SDK files
+
+1. Clone this repository.
+2. Download the Agora Video SDK from [Agora.io SDK](https://www.agora.io/en/download/).
+3. Unzip the downloaded SDK package.
+4. Copy the .jar file from the **libs** folder of the downloaded SDK package to the **/apps/libs** folder of the sample application.
+5. Copy the .so files from the **armeabi-v7a** folder of the downloaded SDK package to the **/app/src/main/jniLibs/armeabi-v7a** folder of the sample application.
+6. *(Optional)* Copy the .so files from the **arm64-v8a** folder of the downloaded SDK package to the **/app/src/main/jniLibs/arm64-v8a** folder of the sample application.
+7. *(Optional)* Copy the .so files from the **x86** folder of the downloaded SDK package to the **/app/src/main/jniLibs/x86** folder of the sample application.
 
 
 

diff --git a/Group-Video/OpenVideoCall-Android/README.zh.md b/Group-Video/OpenVideoCall-Android/README.zh.md
@@ -67,6 +67,9 @@
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/Group-Video/OpenVideoCall-Web/README.md b/Group-Video/OpenVideoCall-Web/README.md
@@ -16,8 +16,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Open the **src/utils/Settings.js** file. At the bottom of the file, replace `<#YOUR APP ID#>` with the App ID from the dashboard.

diff --git a/Group-Video/OpenVideoCall-Web/README.zh.md b/Group-Video/OpenVideoCall-Web/README.zh.md
@@ -44,6 +44,9 @@
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/Group-Video/OpenVideoCall-Windows/README.md b/Group-Video/OpenVideoCall-Windows/README.md
@@ -37,8 +37,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Define the APP_ID with your App ID.

diff --git a/Group-Video/OpenVideoCall-Windows/README.zh.md b/Group-Video/OpenVideoCall-Windows/README.zh.md
@@ -64,6 +64,9 @@ Agora 视频 SDK 支持 iOS / Android / Windows / macOS 等多个平台，你可
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/Group-Video/OpenVideoCall-iOS-Objective-C/README.md b/Group-Video/OpenVideoCall-iOS-Objective-C/README.md
@@ -24,8 +24,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Open `OpenVideoCall.xcodeproj` and edit the `KeyCenter.m` file. Update `<#Your App Id#>` with your app ID.

diff --git a/Group-Video/OpenVideoCall-iOS-Objective-C/README.zh.md b/Group-Video/OpenVideoCall-iOS-Objective-C/README.zh.md
@@ -51,6 +51,9 @@ static let AppId: String = "Your App ID"
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/Group-Video/OpenVideoCall-iOS/README.md b/Group-Video/OpenVideoCall-iOS/README.md
@@ -26,8 +26,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Open `OpenVideoCall.xcodeproj` and edit the `KeyCenter.swift` file. In the `agoraKit` declaration, update `<#Your App Id#>` with your app ID.

diff --git a/Group-Video/OpenVideoCall-iOS/README.zh.md b/Group-Video/OpenVideoCall-iOS/README.zh.md
@@ -51,6 +51,9 @@ static let AppId: String = "Your App ID"
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/Group-Video/OpenVideoCall-macOS/README.md b/Group-Video/OpenVideoCall-macOS/README.md
@@ -28,8 +28,8 @@ This section shows you how to prepare, build, and run the sample application.
 ### Obtain an App ID
 
 To build and run the sample application, get an App ID:
-1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/).
-2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation.
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
 3. Copy the **App ID** from the Dashboard.
 
 4. Open `OpenVideoCall.xcodeproj` and edit the `KeyCenter.m` file. Update `<#Your App Id#>` with your app ID.

diff --git a/Group-Video/OpenVideoCall-macOS/README.zh.md b/Group-Video/OpenVideoCall-macOS/README.zh.md
@@ -52,6 +52,9 @@ static let AppId: String = "Your App ID"
 ## 联系我们
 
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 如果在集成中遇到问题, 你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
+- 如果有售前咨询问题, 可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
 - 如果发现了示例代码的 bug, 欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## 代码许可

diff --git a/One-to-One-Video/Agora-Android-Tutorial-1to1/README.md b/One-to-One-Video/Agora-Android-Tutorial-1to1/README.md
@@ -1,50 +1,55 @@
-# Agora Android 1-to-1 Tutorial
+# Android 1-to-1 Tutorial
 
-*Read this in other languages: [中文](README.zh.md)*
+*English | [中文](README.zh.md)*
 
-This tutorial enables you to quickly get started in your development efforts to create an Android app with real-time video calls, voice calls, and interactive broadcasting. With this sample app you can:
+This tutorial enables you to quickly get started in your development efforts to create an Android app with real-time video calls, voice calls, and interactive broadcasting.
 
-* Join and leave a channel.
-* Mute and unmute audio.
-* Enable or disable video.
-* Choose between the front or rear camera.
+With this sample app, you can:
+- Join and leave a channel.
+- Mute and unmute audio.
+- Enable or disable video.
+- Choose between the front or rear camera.
 
-A more complete demonstration can be found [here](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-Android).
+A more complete demo can be found [here](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-Android).
 
 ## Prerequisites
 
-* Android Studio 3.3 or above.
-* Android device (e.g. Nexus 5X). A real device is recommended because some simulators have missing functionality or lack the performance necessary to run the sample.
+- Android Studio 3.3 or above
+- Android device (e.g. Nexus 5X). A real device is recommended because some simulators have missing functionality or lack the performance necessary to run the sample.
 
 ## Quick Start
+
 This section shows you how to prepare, build, and run the sample application.
 
-### Create an Account and Obtain an App ID
-In order to build and run the sample application you must obtain an App ID: 
+### Obtain an App ID
 
+To build and run the sample application, get an App ID:
 1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
 2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
-3. Locate the file **app/src/main/res/values/strings.xml** and replace <#YOUR APP ID#> with the App ID in the dashboard.
+3. Copy the **App ID** from the Dashboard.
+
+4. Locate the file **app/src/main/res/values/strings.xml** and replace <#YOUR APP ID#> with the App ID in the dashboard.
 
 ```xml
 <string name="agora_app_id"><#YOUR APP ID#></string>
 ```
 
-### Integrate the Agora Video SDK into the sample project
+### Integrate the Agora Video SDK
+
 The SDK must be integrated into the sample project before it can opened and built. There are two methods for integrating the Agora Video SDK into the sample project. The first method uses JCenter to automatically integrate the SDK files. The second method requires you to manually copy the SDK files to the project.
 
 #### Method 1 - Integrate the SDK Automatically Using JCenter (Recommended)
 
 1. Clone this repository.
 2. Open **app/build.gradle** and add the following line to the `dependencies` list:
 
-```
-...
-dependencies {
-    ...
-    implementation 'io.agora.rtc:full-sdk:2.4.0'
-}
-```
+  ```
+  ...
+  dependencies {
+      ...
+      implementation 'io.agora.rtc:full-sdk:2.4.0'
+  }
+  ```
 
 #### Method 2 - Manually copy the SDK files
 
@@ -56,24 +61,20 @@ dependencies {
 6. *(Optional)* Copy the .so files from the **arm64-v8a** folder of the downloaded SDK package to the **/app/src/main/jniLibs/arm64-v8a** folder of the sample application.
 7. *(Optional)* Copy the .so files from the **x86** folder of the downloaded SDK package to the **/app/src/main/jniLibs/x86** folder of the sample application.
 
+
 
-### Obtain and Build the Sample Application 
+### Run the Application
 
-1. Open the sample application in Android Studio.
-2. Build and run the sample project. This should display the application on your device.
+Open project with Android Studio, connect your Android device, build and run.
+
+Or use `Gradle` to build and run.
 
-## Resources
-* A detailed code walkthrough for this sample is available in [Steps to Create this Sample](./guide.md).
-* You can find full API documentation at the [Document Center](https://docs.agora.io/en/).
-* You can file bugs about this sample [here](https://github.com/AgoraIO/Basic-Video-Call/issues).
 
+## Resources
 
-## Learn More
-- 1 to 1 Video Tutorial for [iOS/Swift](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-iOS-Tutorial-Swift-1to1)
-- 1 to 1 Video Tutorial for [iOS/Objective-C](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-macOS-Tutorial-Objective-C-1to1)
-- 1 to 1 Video Tutorial for [macOS](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-macOS-Tutorial-Swift-1to1)
-- 1 to 1 Video Tutorial for [Windows](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-Windows-Tutorial-1to1)
-- 1 to 1 Video Tutorial for [Web](https://github.com/AgoraIO/Basic-Video-Call/tree/master/One-to-One-Video/Agora-Web-Tutorial-1to1)
+- You can find full API document at [Document Center](https://docs.agora.io/en/)
+- You can file bugs about this demo at [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## License
-This software is under the MIT License (MIT). [View the license](LICENSE.md).
+
+The MIT License (MIT)
diff --git a/One-to-One-Video/Agora-Android-Tutorial-1to1/README.yaml b/One-to-One-Video/Agora-Android-Tutorial-1to1/README.yaml
@@ -0,0 +1,46 @@
+Meta:
+  name: Android 1-to-1 Tutorial
+  # en or cn
+  lang: en
+  # | 代表这里是字符串
+  description: |
+    This tutorial enables you to quickly get started in your development efforts to create an Android app with real-time video calls, voice calls, and interactive broadcasting.
+    
+    With this sample app, you can:
+    - Join and leave a channel.
+    - Mute and unmute audio.
+    - Enable or disable video.
+    - Choose between the front or rear camera.
+
+    A more complete demo can be found [here](https://github.com/AgoraIO/Basic-Video-Call/tree/master/Group-Video/OpenVideoCall-Android).
+
+Prerequisites:
+  - Android Studio 3.3 or above
+  - Android device (e.g. Nexus 5X). A real device is recommended because some simulators have missing functionality or lack the performance necessary to run the sample.
+
+QuickStart:
+  description:
+    This section shows you how to prepare, build, and run the sample application.
+  sections:
+    - title: Obtain an App ID
+      content: |
+        $_{APPID}
+        4. Locate the file **app/src/main/res/values/strings.xml** and replace <#YOUR APP ID#> with the App ID in the dashboard.
+
+        ```xml
+        <string name="agora_app_id"><#YOUR APP ID#></string>
+        ```
+    - title: Integrate the Agora Video SDK
+      content: |
+        $_{ANDROID_INTEGRATE}
+            
+    - title: Run the Application
+      content: |
+        $_{ANDROID_RUN}
+
+Resources:
+  document: https://docs.agora.io/en/
+  issue: https://github.com/AgoraIO/Basic-Video-Call/issues
+
+License:
+  type: MIT