File: README.rst

package info (click to toggle)
olm 3.2.16%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 3,212 kB
  • sloc: cpp: 15,245; ansic: 10,894; java: 3,244; objc: 2,291; javascript: 1,882; python: 1,839; makefile: 437; sh: 245; asm: 7; xml: 1
file content (33 lines) | stat: -rw-r--r-- 1,012 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
OLMKit
======

OLMKit exposes an Objective-C wrapper to libolm.

The original work by Chris Ballinger can be found at https://github.com/chrisballinger/OLMKit.

Installation
------------
You can embed OLMKit to your application project with CocoaPods. The pod for
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` 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 and the Swift package.