Swift package: Update instructions
This commit is contained in:
parent
09fbb9e966
commit
26bd2fc35d
3 changed files with 12 additions and 4 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -12,6 +12,7 @@
|
||||||
|
|
||||||
# Xcode
|
# Xcode
|
||||||
build/
|
build/
|
||||||
|
.build/
|
||||||
DerivedData/
|
DerivedData/
|
||||||
*.pbxuser
|
*.pbxuser
|
||||||
!default.pbxuser
|
!default.pbxuser
|
||||||
|
|
|
@ -117,7 +117,7 @@ Note that bindings may have a different license from libolm.
|
||||||
## Release process
|
## Release process
|
||||||
|
|
||||||
First: bump version numbers in ``common.mk``, ``CMakeLists.txt``,
|
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
|
and ``android/olm-sdk/build.gradle`` (``versionCode``, ``versionName`` and
|
||||||
``version``).
|
``version``).
|
||||||
|
|
||||||
|
|
|
@ -12,15 +12,22 @@ the latest OLMKit release is::
|
||||||
|
|
||||||
pod 'OLMKit'
|
pod 'OLMKit'
|
||||||
|
|
||||||
|
Or you can use Swift Package Manager with the URL::
|
||||||
|
|
||||||
|
https://gitlab.matrix.org/matrix-org/olm
|
||||||
|
|
||||||
Development
|
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.
|
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.
|
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
|
Release
|
||||||
-------
|
-------
|
||||||
See ../README.rst for the release of the CocoaPod.
|
See ../README.rst for the release of the CocoaPod and the Swift package.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue