Readme update

toshish · Jun 28, 2020 · bbfba14 · bbfba14
1 parent b5e06fc
commit bbfba14
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 49 deletions.
diff --git a/Group-Video/OpenVideoCall-Android/README.md b/Group-Video/OpenVideoCall-Android/README.md
@@ -78,7 +78,7 @@ Open project with Android Studio, connect your Android device, build and run.
 Or use `Gradle` to build and run.
 
 
-## Resources
+## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/cn/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-Linux/README.md b/Group-Video/OpenVideoCall-Linux/README.md
@@ -38,34 +38,49 @@ configue parameters in run.sh.
 Using 'make' command to build the demo. Using ./run.sh to run demo
 openVideoCall is a commandline demo. Commands as follows:
 - open
+
   open video call
 - close
+
   close video call
 - enable_video
+
   enable/disable video, 'enable_video 0' means disable video, 'enable_video 1' means enable video
 - enable_audio
+
   enable/disable audio, 'enable_audio 0' means disable audio, 'enable_audio 1' means enable audio
 - enable_local_video
+
   enable/disable local video, 'enable_local_video 0' means disable local video(local camera), 'enable_local_video 1' means enable local video
 - mute_local_video
+
   mute/unmute local video, 'mute_local_video 0' means unmute local video(local camera), 'mute_local_video 1' means mute local video
 - mute_local_audio
+
   mute/unmute local audio, 'mute_local_audio 0' means unmute local audio(local audio device), 'mute_local_audio 1' means mute local audio
 - print_device_info
+
   print video and audio device info
 - set_cur_camera
+
   set current carmera,'set_cur_camera deviceId' you can get deviceID by print_device_info
 - exit
+
   exit app
 
 ## Developer Environment Requirements
 * VC2013 or higher
 * WIN7 or higher
 
-## Connect Us
+## Contact Us
 
-- You can find full API document at [Document Center](https://docs.agora.io/en/)
-- You can fire bugs about this demo at [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
+- For potential issues, take a look at our [FAQ](https://docs.agora.io/cn/faq) first
+- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials
+- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case
+- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community)
+- You can find full API documentation at [Document Center](https://docs.agora.io/en/)
+- If you encounter problems during integration, you can ask question in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io)
+- You can file bugs about this sample at [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
 
 ## License
 

diff --git a/Group-Video/OpenVideoCall-Linux/README.zh.md b/Group-Video/OpenVideoCall-Linux/README.zh.md
@@ -68,17 +68,16 @@ command:
 * Compiler:
   - gcc 4.8 and above
 
-## 音视频依赖的预安装库
-*
-
-
-
 
 ## 联系我们
 
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
-- 如果在集成中遇到问题，你可以到 [开发者社区](https://dev.agora.io/cn/) 提问
-- 如果有售前咨询问题，可以拨打 400 632 6626，或加入官方Q群 12742516 提问
+- 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
+- 如果有售前咨询问题，可以拨打 400 632 6626
 - 如果需要售后技术支持，你可以在 [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
@@ -55,7 +55,7 @@ To build and run the sample application, get an App ID:
     **Note:** In some cases, you may need to open a browser and enter `http://localhost:8080` as the URL.
 
 
-## Resources
+## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/cn/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-Web/README.zh.md b/Group-Video/OpenVideoCall-Web/README.zh.md
@@ -16,7 +16,7 @@
 ### 创建Agora账号并获取AppId
 
 在编译和启动实例程序前，您需要首先获取一个可用的App ID:
-1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号
+1. 在 [agora.io](https://dashboard.agora.io/signin/) 创建一个开发者账号
 2. 前往后台页面，点击左部导航栏的 **项目 > 项目列表** 菜单
 3. 复制后台的 **App ID** 并备注，稍后启动应用时会用到它
 4. 在项目页面生成临时 **Access Token** (24小时内有效)并备注，注意生成的Token只能适用于对应的频道名。
@@ -47,10 +47,10 @@
 
 ## 联系我们
 
-- 如果你遇到了困难，可以先参阅[常见问题](https://docs.agora.io/cn/faq)
-- 如果你想了解更多官方示例，可以参考[官方SDK示例](https://github.com/AgoraIO)
-- 如果你想了解声网SDK在复杂场景下的应用，可以参考[官方场景案例](https://github.com/AgoraIO-usecase)
-- 如果你想了解声网的一些社区开发者维护的项目，可以查看[社区](https://github.com/AgoraIO-Community)
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
 - 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
 - 如果发现了示例代码的 bug，欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)

diff --git a/Group-Video/OpenVideoCall-Windows-MFC/README.md b/Group-Video/OpenVideoCall-Windows-MFC/README.md
@@ -1,4 +1,4 @@
-# Open Video Call Windows
+# Open Video Call Windows MFC
 
 *English | [中文](README.zh.md)*
 
@@ -61,7 +61,7 @@ To build and run the sample application, get an App ID:
 please select the OpenVideoCall project in the Solution Explorer and right click. In the pop-up menu bar, select "Set as active project" to solve. Then run the program again.
 
 
-## Resources
+## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/cn/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-Windows-MFC/README.zh.md b/Group-Video/OpenVideoCall-Windows-MFC/README.zh.md
@@ -37,7 +37,7 @@ Agora 视频 SDK 支持 iOS / Android / Windows / macOS 等多个平台，你可
 ### 创建Agora账号并获取AppId
 
 在编译和启动实例程序前，您需要首先获取一个可用的App ID:
-1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号
+1. 在 [agora.io](https://dashboard.agora.io/signin/) 创建一个开发者账号
 2. 前往后台页面，点击左部导航栏的 **项目 > 项目列表** 菜单
 3. 复制后台的 **App ID** 并备注，稍后启动应用时会用到它
 4. 将 AppID 内容替换至 APP_ID 宏定义中
@@ -63,10 +63,10 @@ Agora 视频 SDK 支持 iOS / Android / Windows / macOS 等多个平台，你可
 ## 联系我们
 
 
-- 如果你遇到了困难，可以先参阅[常见问题](https://docs.agora.io/cn/faq)
-- 如果你想了解更多官方示例，可以参考[官方SDK示例](https://github.com/AgoraIO)
-- 如果你想了解声网SDK在复杂场景下的应用，可以参考[官方场景案例](https://github.com/AgoraIO-usecase)
-- 如果你想了解声网的一些社区开发者维护的项目，可以查看[社区](https://github.com/AgoraIO-Community)
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
 - 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
 - 如果发现了示例代码的 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
@@ -1,4 +1,4 @@
-``# Open Video Call Windows
+# Open Video Call Windows
 
 *English | [中文](README.zh.md)*
 
@@ -48,7 +48,7 @@ Finally, Open OpenVideoCall.pro with your Qt5.6(or higher) and build current pro
 
 **Note：**If you fill appid in the code file, appid in ini file will be omitted.
 
-## Connect Us
+## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/cn/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-Windows/README.zh.md b/Group-Video/OpenVideoCall-Windows/README.zh.md
@@ -45,24 +45,14 @@ Agora 视频 SDK 支持 iOS / Android / Windows / macOS 等多个平台，你可
     [BaseInfo]
     AppId=xxxx
 
-**注意：**如果代码里指定了appid就不会使用ini文件的appid。
-
-
-## 联系我们
-
-- 完整的 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)
-
+**注意：** 如果代码里指定了appid就不会使用ini文件的appid。
 
 ## 联系我们
 
-- 如果你遇到了困难，可以先参阅[常见问题](https://docs.agora.io/cn/faq)
-- 如果你想了解更多官方示例，可以参考[官方SDK示例](https://github.com/AgoraIO)
-- 如果你想了解声网SDK在复杂场景下的应用，可以参考[官方场景案例](https://github.com/AgoraIO-usecase)
-- 如果你想了解声网的一些社区开发者维护的项目，可以查看[社区](https://github.com/AgoraIO-Community)
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
 - 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
 - 如果发现了示例代码的 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
@@ -55,7 +55,7 @@ To build and run the sample application, get an App Id:
   
 2. Connect your iPhone or iPad device and run the project. Ensure a valid provisioning profile is applied or your project will not run.
 
-## Contract Us
+## Contact Us
 
 - For potential issues, you may take a look at our [FAQ](https://docs.agora.io/en/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-iOS/README.md b/Group-Video/OpenVideoCall-iOS/README.md
@@ -50,7 +50,7 @@ To build and run the sample application, get an App Id:
 
 2. Connect your iPhone or iPad device and run the project. Ensure a valid provisioning profile is applied or your project will not run.
 
-## Contract Us
+## Contact Us
 
 - For potential issues, you may take a look at our [FAQ](https://docs.agora.io/en/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-macOS/README.md b/Group-Video/OpenVideoCall-macOS/README.md
@@ -50,7 +50,7 @@ To build and run the sample application, get an App Id:
 
 2. Open Xcode and run this project.
 
-## Contract Us
+## Contact Us
 
 - For potential issues, you may take a look at our [FAQ](https://docs.agora.io/en/faq) first
 - Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials

diff --git a/Group-Video/OpenVideoCall-macOS/README.zh.md b/Group-Video/OpenVideoCall-macOS/README.zh.md
@@ -28,7 +28,7 @@
 
 在编译和启动实例程序前，您需要首先获取一个可用的App Id:
 
-1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号。
+1. 在 [agora.io](https://dashboard.agora.io/signin/) 创建一个开发者账号。
 2. 前往后台页面，点击左部导航栏的 **项目 > 项目列表** 菜单。
 3. 复制后台的 **App Id** 并备注，稍后启动应用时会用到它。
 4. 在项目页面生成临时 **Access Token** (24小时内有效)并备注，注意生成的Token只能适用于对应的频道名。
@@ -53,10 +53,10 @@
 
 ## 联系我们
 
-- 如果你遇到了困难，可以先参阅[常见问题](https://docs.agora.io/cn/faq)
-- 如果你想了解更多官方示例，可以参考[官方SDK示例](https://github.com/AgoraIO)
-- 如果你想了解声网SDK在复杂场景下的应用，可以参考[官方场景案例](https://github.com/AgoraIO-usecase)
-- 如果你想了解声网的一些社区开发者维护的项目，可以查看[社区](https://github.com/AgoraIO-Community)
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
 - 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
 - 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
 - 如果发现了示例代码的 bug，欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)