[Documentation] Update the Manual Installation Instruction (#208)

README.md

@@ -54,7 +54,7 @@ let options = GroupCallOptions(credential: communicationTokenCredential,
 callComposite.launch(with: options)
 ```
 
-For more details on Mobile UI Library functionalities visit the [API Reference Documentation](https://azure.github.io/azure-sdk-for-ios/AzureCommunicationUI/index.html).
+For more details on Mobile UI Library functionalities visit the [API Reference Documentation](https://azure.github.io/azure-sdk-for-ios/AzureCommunicationUICalling/index.html).
 
 
 ## Contributing to the Library or Sample

docs/manual-installation.md

@@ -1,25 +1,79 @@
 ## Embedded Framework Installation
 
-### Prerequisties
+### Manual Installation Steps
 
-Azure Communication Mobile UI Library requires a few dependencies. Please import the following libraries into your project if you prefer manually embedding Mobile UI Library.  
+1. Download/clone/submodule the latest [`AzureCommunicationUICalling`](https://github.com/Azure/azure-communication-ui-library-ios) Library to your project root directory.
+2. Open your existing iOS application Xcode project in `xcworkspace`.
+3. Drag the `AzureCommunicationUICalling.xcodeproj` from the newly added subfolder path `/AzureCommunicationUI/sdk/AzureCommunicationUICalling` into your Xcode project's `xcworkspace`.
+4. Select your application project in the Xcode Navigator, and open the target that you want to import Mobile UI Library.
+5. Open the "General" panel and click on the `+` button under the "Frameworks and Libraries" section.
+6. Select `AzureCommunicationUICalling.framework` and then you can `import AzureCommunicationUICalling` inside your project to use Mobile UI Library.
+7. Follow the [Other Dependencies Installation](#other-dependencies-installation) section to include all dependencies in your project. 
+8. Select project `AzureCommunicationUICalling.xcodeproj` in your workspace, open the target and scroll to the "Frameworks and Libraries" section, link dependent frameworks `libFluentUI.a`, `AzureCommunicationCalling` and `AzureCommunicationCommon`. Update the frameworks to `Do Not Embed` for reducing the app size purpose.
 
-- [MicrosoftFluentUI](https://github.com/microsoft/fluentui-apple)  
-- [AzureCommunicationCalling](https://github.com/Azure/azure-sdk-for-ios/tree/main/sdk/communication/AzureCommunicationCalling)
-- [SwiftLint](https://github.com/realm/SwiftLint)
+#### How to fix the issues
+
+- **Buildtime issue: 'unable to open file(...)' - 'Pods-AzureCommunicationUICalling.debug.xcconfig...'**
+
+    Navigate to the project `AzureCommunicationUICalling.xcodeproj` in Xcode, delete the whole folder `Pods` with red name. 
+
+- **Buildtime issue: 'Framework not found Pods_AzureCommunicationUICalling.'**
+
+    1. Select Navigator and navigate to the target `AzureCommunicationUICalling`.
+    2. Delete the `Pods_AzureCommunicationUICalling.framework` under "Frameworks and Libraries" section. 
+
+- **Buildtime issue: 'The sandbox is not in sync with the Podfile.lock.'**
+
+    1. Select Navigator and navigate to the target `AzureCommunicationUICalling` and choose `Build Phases`.
+    2. Delete the script `[CP] Check Pods Manifest.lock`.
+
+- **Buildtime issue: 'Command PhaseScriptExecution failed with a nonzero exit code' - 'SwiftLint'**
+
+    1. Select Navigator and navigate to the target `AzureCommunicationUICalling` and choose `Build Phases`.
+    2. Delete the script `Run SwiftLint`.
+
+### Other Dependencies Installation
+
+Azure Communication Mobile UI Library requires a few dependencies. Please embed the following libraries into your project if you prefer manually embedding Mobile UI Library. And you can refer from each library's Podspec file for the required source files.
+
+#### 1. [AzureCommunicationCalling](https://github.com/Azure/azure-sdk-for-ios/tree/main/sdk/communication/AzureCommunicationCalling) version require: [2.2.0-beta.1](https://github.com/Azure/Communication/releases/tag/v2.2.0-beta.1)
+- Drag the `AzureCommunicationCalling.xcframework` into your project. Add it as embedded framework in your target's "Frameworks and Libraries" section. 
+
+#### 2. [AzureCommunicationCommon](https://github.com/Azure/azure-sdk-for-ios/tree/main/sdk/communication/AzureCommunicationCommon) - version [1.0.3](https://github.com/Azure/azure-sdk-for-ios/releases/tag/AzureCommunicationCommon_1.0.3)
+- Find the project [AzureCommunicationCommon.xcodeproj](https://github.com/Azure/azure-sdk-for-ios/tree/main/sdk/communication/AzureCommunicationCommon) in the repo source code and drag it into your project. 
+- Follow [same steps 1-6](#manual-installation-steps) of embedding `AzureCommunicationUICalling` and add `AzureCommunicationCommon` to your project. 
+
+**Related Issues**
+
+Note: Please refer to [How to fix the issues](#how-to-fix-the-issues) to fix some common issues. 
+
+- **Buildtime issue: 'framework not found AzureCore'**
+
+    1. Select Navigator and navigate to the target `AzureCommunicationCommon`.
+    2. Delete the `AzureCore.framework` under "Frameworks and Libraries" section. 
+
+- **Buildtime issue: 'Swift Compiler Error'**
+
+    1. Update the source code based on the error. 
+    2. Select Navigator and navigate to the target `AzureCommunicationCommon` and choose `Build Phases`.
+    3. Delete the script `Format And Lint`. 
+
+#### 3. [MicrosoftFluentUI](https://github.com/microsoft/fluentui-apple) - version [0.3.9](https://github.com/microsoft/fluentui-apple/releases/tag/0.3.9_main_0.3) 
+- Follow this [Manual Installation Instruction](https://github.com/microsoft/fluentui-apple#manual-installation) to embed the `libFluentUI.a` in your target's "Frameworks and Libraries" section. 
+
+**Related Issues**
+
+- **Runtime Crash With Fatal Error: 'FluentUI resource bundle is not found'**
+
+    1. Select Navigator and navigate to the target `FluentUI.xcodeproj`, open the folder `Products` and you will see the `FluentUIResources-ios.bundle`. Right Click it and `Show in Finder` to find the bundle source in your finder. 
+    2. Select your own project and the target import FluentUI. Go to tab `Building Phases` and drag the `FluentUIResources-ios.bundle` to the `Copy Bundle Resources` section. 
+    3. Apply same update to the main target in the `AzureCommunicationUICalling.xcodeproj`, by adding the `FluentUIResources-ios.bundle` to the `Copy Bundle Resources` section.
+
+- **Buildtime issue: 'Undefined symbol:...'**
+
+    1. Update your target scheme with `ENABLE_ADDRESS_SANITIZER = YES`. For more instruction, please visit [How do you enable Clang Address Sanitizer in Xcode?](https://stackoverflow.com/questions/32150924/how-do-you-enable-clang-address-sanitizer-in-xcode). 
+
 
-### Manual Installation Steps
 
-- Open Terminal and `cd` to your project root directory
-- Run `git init` if there is no repository set up inside your project
-- Add Mobile UI Library as a git [submodule](https://git-scm.com/docs/git-submodule):
 
-```bash
-git submodule add https://github.com/Azure/azure-communication-ui-library-ios
-```
 
-- Open the newly added folder from running the command and navigate into `AzureCommunicationUICalling` subfolder, drag the `AzureCommunicationUICalling.xcodeproj` into your Xcode project's Navigator
-- Match the deployment target of `AzureCommunicationUICalling.xcodeproj` with your application target
-- Select your application project in the Xcode Navigator, and open the target you want to import Mobile UI Library
-- Open the "General" panel and click on the `+` button under the "Frameworks and Libraries" section
-- Select `AzureCommunicationUICalling.framework` and then you can `import AzureCommunicationUICalling` inside the code to use Mobile UI Library