File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -30,9 +30,15 @@ What is coming:
3030MapCache is available through [ CocoaPods] ( https://cocoapods.org ) . To install it, simply add the following line to your ` Podfile ` :
3131
3232``` ruby
33+ # Podfile
3334pod ' MapCache'
3435```
3536
37+ Then in the folder where you have the ` Podfile ` run the command
38+ ``` shell
39+ pod install
40+ ```
41+
3642
3743## How to use MapCache?
3844In the view controller where you have a ` MKMapView ` , import ` MapCache ` :
@@ -228,6 +234,39 @@ If you need further information you can take a look at
228234### [Reference documentation of MapCache](http :// www.merlos.org/MapCache/).
229235
230236
237+ ## Development
238+
239+ Clone the repo
240+
241+ ```shell
242+ git clone https: // github.com/merlos/MapCache
243+ ```
244+
245+ With Xcode Open the file `Example/ MapCache.xcworkspace `
246+
247+ To check if the pod is ready to be released run the command in the root folder folder
248+
249+ ```shell
250+ pod lib lint MapCache.podspec
251+ ```
252+
253+ ### Generate the documentation
254+
255+ This project uses [jazzy](https :// github.com/realm/jazzy) for generating the [reference documentation](http://www.merlos.org/MapCache/))
256+
257+ To install jazzy
258+ ```
259+ gem install jazzy -- verbose
260+ ```
261+
262+ In the root folder of the project run
263+
264+ ```shell
265+ jazzy
266+ ```
267+
268+ It will generate the html in `docs/ `
269+
231270## You may also like
232271
233272* ** [Open GPX Tracker](https :// github.com/merlos/iOS-Open-GPX-Tracker)**. A free source iOS App to create [GPX](https://en.wikipedia.org/wiki/GPS_Exchange_Format) tracks
You can’t perform that action at this time.
0 commit comments