Skip to content

Commit fe07e5d

Browse files
author
Jakub Petrík
committed
Update README.md 💁
1 parent e00029f commit fe07e5d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# PDFReporterKit
2+
[PDFReporter](http://www.pdfreporting.com) iOS Framework
3+
4+
## Requirements
5+
6+
- iOS 8.0+
7+
- Xcode 7.3+
8+
9+
## Prerequisites
10+
11+
- [j2objc (1.0.2)](https://github.com/google/j2objc)
12+
- [Carthage](https://github.com/Carthage/Carthage)
13+
14+
## Dependencies
15+
16+
- [JRE.framework (1.0.2)](https://github.com/google/j2objc/releases/download/1.0.2/j2objc-1.0.2.zip)
17+
- [libHaru](https://github.com/OpenSoftwareSolutions/libHaru)
18+
- [libPng](https://github.com/OpenSoftwareSolutions/libPng)
19+
- libxml2 (native)
20+
- libsqlite3 (native)
21+
- libz (native)
22+
- Security.framework (native)
23+
24+
## Building
25+
26+
1. Clone this repository `git clone git@github.com:OpenSoftwareSolutions/PDFReporterKit.git`
27+
1. Run `carthage update` from the project root
28+
2. Copy downloaded `JRE.framework` to the project root
29+
3. Run `xcodebuild -project PDFReporterKit.xcodeproj -scheme PDFReporterKit-Universal`
30+
31+
## Installation
32+
33+
1. Build or download the framework
34+
2. Copy framework to your project
35+
3. Set `HEADER_SEARCH_PATHS` to `PATH/TO/PDFReporterKit.framework/Headers`
36+
4. Include dependecies
37+
5. Add `#import <PDFReporterKit/PDFReporterKit.h>` to file which will use the framework (or to `.pch`)
38+
39+
## Usage
40+
41+
See [PDFReporter](https://github.com/OpenSoftwareSolutions/PDFReporter) repository.

0 commit comments

Comments
 (0)