From cfa43d7a2ec483843a8c0d2980d09a9d69212f99 Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 08:59:16 +0100 Subject: [PATCH 1/6] Readme: Delete MatrixKit references. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31edf7a51..35b4c5ae9 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ![GitHub](https://img.shields.io/github/license/vector-im/element-ios) [![Twitter URL](https://img.shields.io/twitter/url?label=Element&url=https%3A%2F%2Ftwitter.com%2Felement_hq)](https://twitter.com/element_hq) -Element iOS is an iOS [Matrix](https://matrix.org/) client provided by [Element](https://element.io/). It is based on [MatrixKit](https://github.com/matrix-org/matrix-ios-kit) and [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk). +Element iOS is an iOS [Matrix](https://matrix.org/) client provided by [Element](https://element.io/). It is based on [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk).

@@ -34,7 +34,7 @@ $ pod install # Create the xcworkspace with all project dependenci $ open Riot.xcworkspace # Open Xcode ``` -Else, you can visit our [installation guide](./INSTALL.md). This guide also offers more details and advanced usage like using [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) and [MatrixKit](https://github.com/matrix-org/matrix-ios-kit) in their development versions. +Else, you can visit our [installation guide](./INSTALL.md). This guide also offers more details and advanced usage like using [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in his development version. ## Contributing From 49e96c0f569ecfc4221a09cc37b9b89b3bf98310 Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 08:59:43 +0100 Subject: [PATCH 2/6] Install guide: Remove MatrixKit references. --- INSTALL.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index b10f6c609..c287edb24 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -44,35 +44,35 @@ $ gem install bundler ## Choose Matrix SDKs version to build -To choose the [MatrixKit](https://github.com/matrix-org/matrix-ios-kit) version (and depending MatrixSDK and OLMKit) you want to develop and build against you will have to modify the right definitions of `$matrixKitVersion` variable in the `Podfile`. +To choose the [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) version (and depending OLMKit) you want to develop and build against you will have to modify the right definitions of `$matrixSDKVersion` variable in the `Podfile`. ### Determine your needs -To select which `$matrixKitVersion` value to use you have to determine your needs: +To select which `$matrixSDKVersion` value to use you have to determine your needs: - **Build an App Store release version** -To build the last published App Store code you just need to checkout master branch. If you want to build an older App Store version just checkout the tag of the corresponding version. You have nothing to modify in the `Podfile`. In this case `$matrixKitVersion` will be set to a specific version of the MatrixKit already published on CocoaPods repository. +To build the last published App Store code you just need to checkout master branch. If you want to build an older App Store version just checkout the tag of the corresponding version. You have nothing to modify in the `Podfile`. In this case `$matrixSDKVersion` will be set to a specific version of the MatrixSDK already published on CocoaPods repository. - **Build last development code and modify Element project only** -If you want to build last development code you have to checkout the develop branch and use `$matrixKitVersion = {'develop' => 'develop'}` in the `Podfile`. This will also use MatrixKit and MatrixSDK develop branches. +If you want to build last development code you have to checkout the `develop` branch and use `$matrixSDKVersion = {:branch => 'develop'}` in the `Podfile`. This will also use MatrixSDK develop branche. -- **Build specific branch of Kit and SDK and modify Element project only** +- **Build specific branch of SDK and modify Element project only** -If you want to build a specific branch for the MatrixKit and the MatrixSDK you have to indicate them using a dictionary like this: `$matrixKitVersion = {'kit_branch_name' => 'sdk_branch_name'}`. +If you want to build a specific branch for the MatrixSDK you have to indicate it using a dictionary like this: `$matrixSDKVersion = {:branch => 'sdk_branch_name'}`. -- **Build any branch and be able to modify MatrixKit and MatrixSDK locally** +- **Build any branch and be able to modify MatrixSDK locally** -If you want to modify MatrixKit and/or MatrixSDK locally and see the result in Element project you have to uncommment `$matrixKitVersion = :local` in the `Podfile`. -But before you have to checkout [MatrixKit](https://github.com/matrix-org/matrix-ios-kit) repository in `../matrix-ios-kit` and [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in `../matrix-ios-sdk` locally relatively to your Element iOS project folder. -Be sure to use compatible branches for Element iOS, MatrixKit and MatrixSDK. For example, if you want to modify Element iOS from develop branch, use MatrixKit and MatrixSDK develop branches and then make your modifications. +If you want to modify MatrixSDK locally and see the result in Element project you have to uncommment `$matrixSDKVersion = :local` in the `Podfile`. +But before you have to checkout [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in `../matrix-ios-sdk` locally relatively to your Element iOS project folder. +Be sure to use compatible branches for Element iOS and MatrixSDK. For example, if you want to modify Element iOS from develop branch, use MatrixSDK develop branche and then make your modifications. **Important**: By working with [XcodeGen](https://github.com/yonaskolb/XcodeGen) you will need to use the _New Build System_ in Xcode, to have your some of the xcconfig variables taken into account. It should be enabled by default on the latest Xcode versions, but if you need to enable it go to Xcode menu and select `File > Workspace Settings… > Build System` and then choose `New Build System`. -### `$matrixKitVersion` Modification +### `$matrixSDKVersion` Modification -Every time you change the `$matrixKitVersion` variable in the `Podfile`, you have to run the `pod install` command again. +Every time you change the `$matrixSDKVersion` variable in the `Podfile`, you have to run the `pod install` command again. ## Build @@ -110,8 +110,7 @@ Or if you prefer to use directly CocoaPods: $ pod install ``` -This will load all dependencies for the Element source code, including [MatrixKit](https://github.com/matrix-org/matrix-ios-kit) -and [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk). +This will load all dependencies for the Element source code, including [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk). ### Open workspace From b19fa2b421e7fd64cf0d4eef0da87d4f379023cc Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 09:35:27 +0100 Subject: [PATCH 3/6] Update README.md Co-authored-by: manuroe --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35b4c5ae9..704f07064 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ $ pod install # Create the xcworkspace with all project dependenci $ open Riot.xcworkspace # Open Xcode ``` -Else, you can visit our [installation guide](./INSTALL.md). This guide also offers more details and advanced usage like using [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in his development version. +Else, you can visit our [installation guide](./INSTALL.md). This guide also offers more details and advanced usage like using [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in its development version. ## Contributing From b9df002ef2557dbd11c450ac7bbb88410f01f1f4 Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 09:37:21 +0100 Subject: [PATCH 4/6] Update INSTALL.md Co-authored-by: manuroe --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index c287edb24..ad9ffe79c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -66,7 +66,7 @@ If you want to build a specific branch for the MatrixSDK you have to indicate it If you want to modify MatrixSDK locally and see the result in Element project you have to uncommment `$matrixSDKVersion = :local` in the `Podfile`. But before you have to checkout [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in `../matrix-ios-sdk` locally relatively to your Element iOS project folder. -Be sure to use compatible branches for Element iOS and MatrixSDK. For example, if you want to modify Element iOS from develop branch, use MatrixSDK develop branche and then make your modifications. +Be sure to use compatible branches for Element iOS and MatrixSDK. For example, if you want to modify Element iOS from develop branch, use MatrixSDK develop branch and then make your modifications. **Important**: By working with [XcodeGen](https://github.com/yonaskolb/XcodeGen) you will need to use the _New Build System_ in Xcode, to have your some of the xcconfig variables taken into account. It should be enabled by default on the latest Xcode versions, but if you need to enable it go to Xcode menu and select `File > Workspace Settings… > Build System` and then choose `New Build System`. From e0e3e5d7691af64bf667e4d1c97b3ee9f83806dd Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 09:41:13 +0100 Subject: [PATCH 5/6] Install guide: Fix typo. --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index ad9ffe79c..667f308f4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -56,7 +56,7 @@ To build the last published App Store code you just need to checkout master bran - **Build last development code and modify Element project only** -If you want to build last development code you have to checkout the `develop` branch and use `$matrixSDKVersion = {:branch => 'develop'}` in the `Podfile`. This will also use MatrixSDK develop branche. +If you want to build last development code you have to checkout the `develop` branch and use `$matrixSDKVersion = {:branch => 'develop'}` in the `Podfile`. This will also use MatrixSDK develop branch. - **Build specific branch of SDK and modify Element project only** From aa894411f9c922e696ab84d154af26941c9c1e6e Mon Sep 17 00:00:00 2001 From: SBiOSoftWhare Date: Tue, 7 Dec 2021 09:51:38 +0100 Subject: [PATCH 6/6] Podfile: Add :specHash sample for clarity. --- Podfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Podfile b/Podfile index 298eddf8c..5eeaa33f2 100644 --- a/Podfile +++ b/Podfile @@ -16,6 +16,7 @@ use_frameworks! $matrixSDKVersion = '= 0.20.10' # $matrixSDKVersion = :local # $matrixSDKVersion = { :branch => 'develop'} +# $matrixSDKVersion = { :specHash => { git: 'https://git.io/fork123', branch: 'fix' } } ########################################