# Aegir VM-SDK iOS Sample App (PREVIEW 2.2.14)

This sample app demonstrates how to use the Aegir VM-SDK to render
indoor venue maps and add wayfinding directions in an iOS application.

## Supported platforms

VM-SDK supports iOS 16.0 and later.

## Getting started

1. Install Xcode 16.4 or later: <https://developer.apple.com/xcode/>.
2. Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
   if you do not already have it:

   ```sh
   sudo gem install cocoapods
   ```

3. Extract the iOS VMSDK zip file.
4. In the extracted directory, navigate into `vmsdk-sampleapp/`.
5. Generate a [MapTiler API key](https://cloud.maptiler.com/account/keys/).
6. Create `TestApp/LocalKeys.xcconfig` with your key:

   ```
   MAPTILER_API_KEY=<your_key>
   ```

7. Install dependencies:

   ```sh
   pod install
   ```

8. Open `TestApp.xcworkspace` in Xcode and build the `TestApp` scheme.

## Adding your own venue maps

See [`VENUES.md`](VENUES.md) for the partner drop-in procedure
(directory layout, discovery rules, and remote-venue loading).

## Documentation

- API reference: <https://developer.aegirmaps.com/ios/latest/>
- User guide: <https://developer.aegirmaps.com/docs-ios/2.2/ios-ug>

## License

See `LICENSE.txt` in the parent directory.
