Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Matrixbirds committed Mar 1, 2019
1 parent 7f6ae6d commit 4b225fb
Show file tree
Hide file tree
Showing 12 changed files with 31 additions and 48 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
9 changes: 5 additions & 4 deletions docs/v2/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@

# Step 1. Add `AndroidManifest.xml`
```xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
```

# Step 2. Add `react-native-agora` to `settings.gradle`
Expand Down
9 changes: 5 additions & 4 deletions docs/v2/android.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@

# Step 1. 新增 `AndroidManifest.xml`
```xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
```

# Step 2. 在android目录里的`settings.gradle`新增`react-native-agora`的依赖管理
Expand Down
22 changes: 10 additions & 12 deletions docs/v2/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,24 @@ gem install cocoapods

# Step 1. install pod dependencies
```bash
cd ios
pod install
```
pod install success will create `<projectName>`.xcworkspace file in ios folder.

# Step 2. Open Workspace Project in Xcode
# Step 2. Open the xcworkspace Project in Xcode
Open `ios/projectName.xcworkspace` with XCode
![Step 2](./IOS_INSTALLATION/1.2_OpenProject.png)

# Step 3. Add RCTAgora to the Project Libraries folder
![Step 3.1](./IOS_INSTALLATION/1.3_Add_Files_To_Project.png)
![Step 3.2](./IOS_INSTALLATION/1.3.1_RCTAgora.png)
select the AgoraRtcEngineKit and re-added by below steps.
![Step 3.3](./IOS_INSTALLATION/1.3.3_UPDATE_RCTAgora_AgoraRtcEngineKit_Framework.png)
![Step 3.4](./IOS_INSTALLATION/1.3.4_SELECT_AgoraRtcEngineKit_from_iOS_Pods_folder.png)
![Step 3.5](./IOS_INSTALLATION/1.3.5_DRAG_IT_INTO_Link_Binary_With_Libraries.png)

# Step 4. Add Linked Library to the xcode project
![Step 4.1](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
![Step 4.2](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
![Step 4.3](./IOS_INSTALLATION/1.4.2_SET_RCTAgora.a.png)

# Step 5. Set Framework and Libraries Search Paths
![Step 5.1](./IOS_INSTALLATION/1.5.1_Add_Framework_Search_Paths.png)
![Step 5.2](./IOS_INSTALLATION/1.5.2_Add_Library_Search_Paths.png)


# Step 6. build and run it with xcode
# Step 4. Only Add Linked Library to the xcode project
![Step 4.3](./IOS_INSTALLATION/1.4.1_SET_RCTAgora.a.png)

# Step 5. build and run it with xcode
17 changes: 7 additions & 10 deletions docs/v2/ios.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,13 @@ pod install
# Step 3. 在项目里新增RCTAgora项目到Libraries目录里
![Step 3.1](./IOS_INSTALLATION/1.3_Add_Files_To_Project.png)
![Step 3.2](./IOS_INSTALLATION/1.3.1_RCTAgora.png)
根据以下的步骤。重新加载RCTAgora里面的AgoraRtcEngineKit。
![Step 3.3](./IOS_INSTALLATION/1.3.3_UPDATE_RCTAgora_AgoraRtcEngineKit_Framework.png)
![Step 3.4](./IOS_INSTALLATION/1.3.4_SELECT_AgoraRtcEngineKit_from_iOS_Pods_folder.png)
![Step 3.5](./IOS_INSTALLATION/1.3.5_DRAG_IT_INTO_Link_Binary_With_Libraries.png)

# Step 4. 把react-native-agora添加到linked libraries里
![Step 4.1](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
![Step 4.2](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
![Step 4.3](./IOS_INSTALLATION/1.4.2_SET_RCTAgora.a.png)
# Step 4. 把RCTAgora.a 添加到linked libraries里
![Step 4.3](./IOS_INSTALLATION/1.4.1_SET_RCTAgora.a.png)

# Step 5. 设置 Framework & Libraries Search Paths
![Step 5.1](./IOS_INSTALLATION/1.5.1_Add_Framework_Search_Paths.png)
![Step 5.2](./IOS_INSTALLATION/1.5.2_Add_Library_Search_Paths.png)


# Step 6. xcode 编译并运行
# Step 5. xcode 编译并运行

22 changes: 4 additions & 18 deletions samples/simpleDemo/ios/simpleDemo.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,6 @@
00C302E91ABCBA2D00DB3ED1 /* libRCTNetwork.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 00C302DC1ABCB9D200DB3ED1 /* libRCTNetwork.a */; };
00C302EA1ABCBA2D00DB3ED1 /* libRCTVibration.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 00C302E41ABCB9EE00DB3ED1 /* libRCTVibration.a */; };
00E356F31AD99517003FC87E /* simpleDemoTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 00E356F21AD99517003FC87E /* simpleDemoTests.m */; };
0842E3912206D315003875AC /* libc++.tbd in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E36A2206D315003875AC /* libc++.tbd */; };
0842E3932206D31B003875AC /* libresolv.tbd in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E3922206D31B003875AC /* libresolv.tbd */; };
0842E3952206D320003875AC /* AVFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E3942206D320003875AC /* AVFoundation.framework */; };
0842E3982206D32B003875AC /* VideoToolbox.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E3962206D32B003875AC /* VideoToolbox.framework */; };
0842E3992206D32B003875AC /* AudioToolbox.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E3972206D32B003875AC /* AudioToolbox.framework */; };
0842E39C2206D332003875AC /* CoreMedia.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E39A2206D331003875AC /* CoreMedia.framework */; };
0842E39D2206D332003875AC /* CoreMotion.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E39B2206D332003875AC /* CoreMotion.framework */; };
0842E39F2206D338003875AC /* CoreTelephony.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 0842E39E2206D338003875AC /* CoreTelephony.framework */; };
08CCEBFC221537CD003E31DF /* libRCTAgora.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 08CCEBD7221536C0003E31DF /* libRCTAgora.a */; };
11D1A2F320CAFA9E000508D9 /* libRCTAnimation.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 5E9157331DD0AC6500FF2AA8 /* libRCTAnimation.a */; };
133E29F31AD74F7200F7D852 /* libRCTLinking.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 78C398B91ACF4ADC00677621 /* libRCTLinking.a */; };
Expand Down Expand Up @@ -406,14 +398,6 @@
buildActionMask = 2147483647;
files = (
08CCEBFC221537CD003E31DF /* libRCTAgora.a in Frameworks */,
0842E39F2206D338003875AC /* CoreTelephony.framework in Frameworks */,
0842E39C2206D332003875AC /* CoreMedia.framework in Frameworks */,
0842E39D2206D332003875AC /* CoreMotion.framework in Frameworks */,
0842E3982206D32B003875AC /* VideoToolbox.framework in Frameworks */,
0842E3992206D32B003875AC /* AudioToolbox.framework in Frameworks */,
0842E3952206D320003875AC /* AVFoundation.framework in Frameworks */,
0842E3932206D31B003875AC /* libresolv.tbd in Frameworks */,
0842E3912206D315003875AC /* libc++.tbd in Frameworks */,
ED297163215061F000B7C4FE /* JavaScriptCore.framework in Frameworks */,
ADBDB9381DFEBF1600ED6528 /* libRCTBlob.a in Frameworks */,
11D1A2F320CAFA9E000508D9 /* libRCTAnimation.a in Frameworks */,
Expand Down Expand Up @@ -1436,6 +1420,7 @@
baseConfigurationReference = AF777D8452EEC1290F3E6AE9 /* Pods-simpleDemo.debug.xcconfig */;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
CODE_SIGN_IDENTITY = "iPhone Developer";
CODE_SIGN_STYLE = Manual;
CURRENT_PROJECT_VERSION = 1;
DEAD_CODE_STRIPPING = NO;
Expand All @@ -1459,7 +1444,7 @@
"-ObjC",
"-lc++",
);
PRODUCT_BUNDLE_IDENTIFIER = io.agora.simpleDemo;
PRODUCT_BUNDLE_IDENTIFIER = tori.mobi.agora;
PRODUCT_NAME = simpleDemo;
PROVISIONING_PROFILE_SPECIFIER = "";
VERSIONING_SYSTEM = "apple-generic";
Expand All @@ -1471,6 +1456,7 @@
baseConfigurationReference = 1CD9D1AEC7C4C297784C698B /* Pods-simpleDemo.release.xcconfig */;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
CODE_SIGN_IDENTITY = "iPhone Developer";
CODE_SIGN_STYLE = Manual;
CURRENT_PROJECT_VERSION = 1;
DEVELOPMENT_TEAM = "";
Expand All @@ -1493,7 +1479,7 @@
"-ObjC",
"-lc++",
);
PRODUCT_BUNDLE_IDENTIFIER = io.agora.simpleDemo;
PRODUCT_BUNDLE_IDENTIFIER = tori.mobi.agora;
PRODUCT_NAME = simpleDemo;
PROVISIONING_PROFILE_SPECIFIER = "";
VERSIONING_SYSTEM = "apple-generic";
Expand Down

0 comments on commit 4b225fb

Please sign in to comment.