From 6f113dd7b3b4de918c4efb81d38a1ffe1d391b5b Mon Sep 17 00:00:00 2001 From: manuroe Date: Tue, 27 Sep 2016 11:57:29 +0200 Subject: OLMKit: Make the project build Make OLMKit CocoaPods expose the obj-c wrapper of libolm --- xcode/README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 xcode/README.rst (limited to 'xcode/README.rst') diff --git a/xcode/README.rst b/xcode/README.rst new file mode 100644 index 0000000..db78e57 --- /dev/null +++ b/xcode/README.rst @@ -0,0 +1,22 @@ +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' + +Development +----------- +Run `pod install` and open `OLMKit.xcworkspace`. + +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 into OLMKit.xcworkspace. + -- cgit v1.2.3 From e19b7f54dc81dcaba6902a2d9202e1587ad5c1a1 Mon Sep 17 00:00:00 2001 From: manuroe Date: Thu, 17 Nov 2016 14:43:04 +0100 Subject: OLMKit: Improve wording --- xcode/README.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'xcode/README.rst') diff --git a/xcode/README.rst b/xcode/README.rst index db78e57..d56fa85 100644 --- a/xcode/README.rst +++ b/xcode/README.rst @@ -18,5 +18,9 @@ Run `pod install` and open `OLMKit.xcworkspace`. 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 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. + +Release +------- +See ../README.rst for the release of the CocoaPod. -- cgit v1.2.3