Skip to content

Commit 884ea26

Browse files
authored
Documentation update
* Minor update to documentation for Obj-C projects instructions * Updated dependency installation
1 parent 55ccc1a commit 884ea26

File tree

7 files changed

+85
-42
lines changed

7 files changed

+85
-42
lines changed

Example/Podfile.lock

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
PODS:
2-
- iOSDFULibrary (3.0.5):
2+
- iOSDFULibrary (3.0.6):
33
- Zip (~> 0.6)
44
- Zip (0.6.0)
55

@@ -11,7 +11,7 @@ EXTERNAL SOURCES:
1111
:path: ../
1212

1313
SPEC CHECKSUMS:
14-
iOSDFULibrary: 28bc7eec21bb2cf50d048556391ceb6724aaee12
14+
iOSDFULibrary: e01a7129eef7be58acffff284da0630e6b8759fb
1515
Zip: 805fc2fa9d2f05bbb7762d982d7a42ccdcc51f42
1616

1717
PODFILE CHECKSUM: f02a613149cfa2aac7ce3d85b2697906507f0bdc

Example/Pods/Local Podspecs/iOSDFULibrary.podspec.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Example/Pods/Manifest.lock

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Example/Pods/Pods.xcodeproj/project.pbxproj

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Example/Pods/Target Support Files/iOSDFULibrary/Info.plist

+20-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+28-16
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,43 @@
55

66
## Installation
77

8-
**For Cocoapods:**
9-
- Create/Update your **Podfile** with the following contents
8+
**For Cocoapods(Swift):** ***Using Obj-C?*** [Use these instructions instead](README_OBJC.md)
109

11-
target 'YourAppTargetName' do
12-
use_frameworks!
13-
pod 'iOSDFULibrary'
14-
end
10+
- Create/Update your **Podfile** with the following contents
1511

16-
- Install dependencies
12+
```
13+
target 'YourAppTargetName' do
14+
use_frameworks!
15+
pod 'iOSDFULibrary'
16+
end
17+
```
1718
18-
pod install
19+
- Install dependencies
20+
21+
```
22+
pod install
23+
```
24+
25+
- Open the newly created `.xcworkspace`
26+
27+
- Import the library to any of your classes by using `import iOSDFULibrary` and begin working on your project
1928
20-
- Open the newly created `.xcworkspace` and begin working on your project.
2129
2230
**For Carthage:**
2331
24-
- Create a new **Cartfile** in your project's root with the following contents
32+
- Create a new **Cartfile** in your project's root with the following contents
2533
26-
github "NordicSemiconductor/IOS-Pods-DFU-Library" ~> x.y //Replace x.y with your required version
34+
```
35+
github "NordicSemiconductor/IOS-Pods-DFU-Library" ~> x.y //Replace x.y with your required version
36+
```
2737
28-
- Build with carthage
38+
- Build with carthage
2939
30-
carthage update --platform iOS //also OSX platform is available for macOS builds
40+
```
41+
carthage update --platform iOS //also OSX platform is available for macOS builds
42+
```
3143
32-
- Carthage will build the **iOSDFULibrary.framework** and **Zip.framework** files in **Carthag/Build/**, you may now copy all those files to your project and use the library, additionally, carthade also builds **\*.dsym** files if you need to resymbolicate crash logs. you may want to keep those files bundled with your builds for future use.
44+
- Carthage will build the **iOSDFULibrary.framework** and **Zip.framework** files in **Carthag/Build/**, you may now copy all those files to your project and use the library, additionally, carthade also builds **\*.dsym** files if you need to resymbolicate crash logs. you may want to keep those files bundled with your builds for future use.
3345
3446
---
3547
@@ -87,8 +99,8 @@ The library is compatible with nRF51 and nRF52 devices with S-Series Soft Device
8799
* **SDK 7.0.0** - The extended init packet is required. The init packet contains additional validation information: device type and revision, application version, compatible Soft Devices and the firmware CRC.
88100
* **SDK 8.0.0** - The bond information may be preserved after an application update. The new application, when first started, will send the Service Change indication to the phone to refresh the services. New features:
89101
90-
- Buttonless update support for bonded devices
91-
- sharing the LTK between an app and the bootloader.
102+
- Buttonless update support for bonded devices
103+
- sharing the LTK between an app and the bootloader.
92104
93105
#### Secure DFU
94106

README_OBJC.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# iOS DFU Library
2+
3+
[![Version](http://img.shields.io/cocoapods/v/iOSDFULibrary.svg)](http://cocoapods.org/pods/iOSDFULibrary)
4+
5+
## Installation instructions for Obj-C projects
6+
7+
**Using Cocoapods:**
8+
9+
- Create/Update your **Podfile** with the following contents
10+
```
11+
target 'YourAppTargetName' do
12+
use_frameworks!
13+
pod 'iOSDFULibrary'
14+
end
15+
```
16+
- Install dependencies
17+
18+
pod install
19+
20+
- Open the newly created `.xcworkspace` and begin working on your project.
21+
- If Xcode asks to migrate code to Swift 3, choose **Later**. (The codebase is Swift 3 already)
22+
- Click on the `Pods` project, then go to the `Build Settings`
23+
- Click on the `iOSDFULibrary` target, then set the `Use Legacy Swift version` setting to `No`
24+
- Repeat the same for the `Zip` target.
25+
- Build the project, it should now succeed.
26+
- Import the library to any of your obj-c classes by using `@import iOSDFULibrary;` and begin working on your project.
27+
28+
29+
Currently, the only tested and supported method for Obj-C projects is using Cocoapods.

0 commit comments

Comments
 (0)