From 26bd2fc35d1dc23c5a665319ad4140bb48418132 Mon Sep 17 00:00:00 2001 From: manuroe Date: Tue, 6 Apr 2021 17:18:50 +0200 Subject: [PATCH] Swift package: Update instructions --- .gitignore | 1 + README.md | 2 +- xcode/README.rst | 13 ++++++++++--- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 87c1bbe..95c12e3 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,7 @@ # Xcode build/ +.build/ DerivedData/ *.pbxuser !default.pbxuser diff --git a/README.md b/README.md index 6958d19..73d8005 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ Note that bindings may have a different license from libolm. ## Release process First: bump version numbers in ``common.mk``, ``CMakeLists.txt``, -``javascript/package.json``, ``python/olm/__version__.py``, ``OLMKit.podspec``, +``javascript/package.json``, ``python/olm/__version__.py``, ``OLMKit.podspec``, ``Package.swift``, and ``android/olm-sdk/build.gradle`` (``versionCode``, ``versionName`` and ``version``). diff --git a/xcode/README.rst b/xcode/README.rst index d56fa85..aeff5dc 100644 --- a/xcode/README.rst +++ b/xcode/README.rst @@ -12,15 +12,22 @@ the latest OLMKit release is:: pod 'OLMKit' +Or you can use Swift Package Manager with the URL:: + + https://gitlab.matrix.org/matrix-org/olm + Development ----------- -Run `pod install` and open `OLMKit.xcworkspace`. +Run `pod install` and open `OLMKit.xcworkspace` with Xcode. The project contains only tests files. The libolm and the Objective-C wrapper source files are loaded via the OLMKit CocoaPods pod. To add a new source file, add it to the file system and run `pod update` to make CocoaPods insert it into OLMKit.xcworkspace. +Development alternative +----------------------- +Based on the Swift package, you can build source files and run tests directly from the command line: `swift test`. + Release ------- -See ../README.rst for the release of the CocoaPod. - +See ../README.rst for the release of the CocoaPod and the Swift package.