https://github.com/elastos/elastos.carrierclassic.swift
https://github.com/elastos/elastos.carrierclassic.swift
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elastos/elastos.carrierclassic.swift
- Owner: elastos
- License: gpl-3.0
- Created: 2017-12-28T07:48:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T08:12:54.000Z (over 2 years ago)
- Last Synced: 2023-08-06T18:53:08.660Z (almost 2 years ago)
- Language: Swift
- Size: 464 KB
- Stars: 8
- Watchers: 28
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Elastos Carrier Swift Framework
=============================
[](https://travis-ci.com/elastos/Elastos.NET.Carrier.Swift.SDK)
## Summary
Elastos Carrier Swift Framework is swift API wrapper (and Objective-C APIs) for Elastos Native Carrier, where Carrier is a decentralised peer to peer communication framework.
## Build from source
### 1.Build Carrier NDK
You need to build carrier iOS/Macos ndk distributions from the Carrier native repository with following github address.
```
https://github.com/elastos/Elastos.NET.Carrier.Native.SDK
```
Finished building iOS/Macos NDKs for Carrier, you would need native output libraries **'lipo'ed** with serveral CPU architectures supported. Currently, only **x86-64** and **arm64** CPU architectures are supported.
The output static libraries would be listed under **"_dist/lipo"** directory in Carrier Native source.
### 2.Import Carrier NDK
The directory **"NativeDistributions"** to import native shared libraries and headers should have following directory structure:
```
NativeDistributions
|--include
|--ela_carrier.h
|--ela_session.h
|--CCarrier.swift
|--CSession.swift
|--libs
|-- PLACEHOLDER.md
（Please read the PLACEHOLDER.md）
```
The headers under subdirectory **"include"** are public header files from Carrier native.
### 3. Build Carrier SDK
After importing dependencies from Carrier native, you need Apple Xcode to open this project and build Carrier iOS/Macos SDK.
### 4. Output
Use Apple Xcode to generate **ElastosCarrierSDK.framework**.
## Tests
TODO.
## CocoaPods
### 1. Pod install
The distribution has been published to CocoaPods platform. So, the simple way to use **ElastosCarrierSDK.framework** is just to add the following line to your **Podfile**:
```
pod 'ElastosCarrierSDK'
```
Then run the command below to install it before open your Xcode workspace:
```shell
$ pod install
```
## Build Docs
### 1. Swift APIs Docs
Run following script command to generate swift APIs document with appledoc tool:
```shell
$ ./docs.sh
```
### 2. Object-C APIs Docs
```shell
$ ./docs.sh objc
```
About How to install appledoc, please refer to following github repository:
```
https://github.com/tomaz/appledoc
```
## Thanks
Sincerely thanks to all teams and projects that we relies on directly or indirectly.
## Contributing
We welcome contributions to the Elastos Carrier Swfit Project (or Native Project) in many forms.
## License
Elastos Carrier Swift Project source code files are made available under the GPLv3 License, located in the LICENSE file.