Skip to content

Commit

Permalink
restructure iOS readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stmitt committed Mar 1, 2021
1 parent b257e71 commit 67ad08b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 23 deletions.
21 changes: 20 additions & 1 deletion ios/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,23 @@

# iOS

[Installation & Build Instructions](docs/install_readme.md)
## Installation

Open Mobile Maps is available through [Swift Package Manager](https://swift.org/package-manager/).

### Xcode

For App integration within XCode, add this package to your App target. To do this, follow the step by step tutorial [Adding Package Dependencies to Your App](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).

### Swift Package

Once you have your Swift package set up, adding Open Mobile Maps as a dependency is as easy as adding it to the dependencies value of your Package.swift.

```swift
dependencies: [
.package(url: "https://github.com/geoadmin/lib-open-swiss-maps-sdk.git", .upToNextMajor(from: "1.0.0"))
]
```

## How To use

Expand Down Expand Up @@ -126,3 +142,6 @@ extension MapViewController: MCTiled2dMapRasterLayerCallbackInterface {
}
}
```

## How to build
[Build Instructions](docs/install_readme.md)
27 changes: 5 additions & 22 deletions ios/docs/install_readme.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,5 @@
# iOS

## Installation

Open Mobile Maps is available through [Swift Package Manager](https://swift.org/package-manager/).

### Xcode

For App integration within XCode, add this package to your App target. To do this, follow the step by step tutorial [Adding Package Dependencies to Your App](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).

### Swift Package

Once you have your Swift package set up, adding Open Mobile Maps as a dependency is as easy as adding it to the dependencies value of your Package.swift.

```swift
dependencies: [
.package(url: "https://github.com/geoadmin/lib-open-swiss-maps-sdk.git", .upToNextMajor(from: "1.0.0"))
]
```

### iOS 10

Unfortunately, Swift package is only supported starting with iOS 11. If you need iOS 10 support you have to compile the library as a framework yourself.

## How to build

Expand All @@ -41,4 +20,8 @@ in the folder [djinni](../djinni). This generates the Kotlin bindings, the C++ h

### Building the iOS Package.

The [Package.swift](../Package.swift) file can be opened in Xcode and build directly from there.
The [Package.swift](../Package.swift) file can be opened in Xcode and build directly from there.

### iOS 10

Unfortunately, Swift package is only supported starting with iOS 11. If you need iOS 10 support you have to compile the library as a framework yourself.

0 comments on commit 67ad08b

Please sign in to comment.