Docs setting up Xcode project with Bazel, fix assets example app (#1146)

platform/ios/BUILD.bazel

@@ -419,6 +419,9 @@ objc_library(
         "platform/ios/app/MBXViewController.h",
         "platform/ios/app/MLNMapView_Experimental.h",
     ],
+    data = glob([
+        "platform/ios/app/Assets.xcassets/**",
+    ]),
     includes = [
         "platform/darwin/app",
         "platform/darwin/src",
@@ -443,7 +446,6 @@ _IOS_APPLICATION_RESOURCES = [
     "platform/ios/app/LaunchScreen.storyboard",
     "platform/ios/app/simple_route.json",
     "platform/ios/app/fill_filter_style.json",
-    "platform/ios/app/Assets.xcassets",
     "platform/darwin/test/amsterdam.geojson",
 ] + glob([
     "platform/ios/app/*.lproj/**",

platform/ios/README.md

@@ -1,11 +1,6 @@
 # MapLibre Native for iOS and macOS
 
-MapLibre Native for iOS and macOS is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 9.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [MapLibre GL Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL. It is based on the MapLibre Native library.
+This directory contains the source code of MapLibre Native for Apple platforms (iOS and for macOS).
 
-- [MapLibre Native for iOS](platform/ios/README.md)
-- [MapLibre Native for macOS](platform/macos/README.md)
-
-
-## License
-
-MapLibre Native is licensed under the [2-Clause BSD license](LICENSE.md).
+- [iOS](./platform/ios/README.md)
+- [macOS](./platform/macos/README.md)

platform/ios/platform/ios/README.md

@@ -2,24 +2,59 @@
 
 [![GitHub Action build status](https://github.com/maplibre/maplibre-native/workflows/ios-ci/badge.svg)](https://github.com/maplibre/maplibre-native/actions/workflows/ios-ci.yml) [![GitHub Action build status](https://github.com/maplibre/maplibre-native/workflows/ios-release/badge.svg)](https://github.com/maplibre/maplibre-native/actions/workflows/ios-release.yml)
 
-A library based on [MapLibre Native](https://github.com/maplibre/maplibre-native) for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS using Objective-C, Swift, or Interface Builder.
-
-* [Learn about custom builds](INSTALL.md)
-
-![](docs/img/screenshot.png)
+A library based on [MapLibre Native](https://github.com/maplibre/maplibre-native) for embedding interactive map views with scalable, customizable vector maps into iOS Applications.
 
 ## Getting Started
 
+MapLibre Native for iOS is distributed using the [Swift Package Index](https://swiftpackageindex.com/maplibre/maplibre-gl-native-distribution). To add it to your project, follow the steps below.
+
 1. To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL. You can also navigate to your target’s General pane, and in the “Frameworks, Libraries, and Embedded Content” section, click the + button, select Add Other, and choose Add Package Dependency.
 
-2. Either add MapLibre GitHub distribution URL (https://github.com/maplibre/maplibre-gl-native-distribution) or search for `maplibre-native` package.
+2. Either add MapLibre GitHub distribution URL `https://github.com/maplibre/maplibre-gl-native-distribution` or search for `maplibre-native` package.
 
-3. Choose "next". Xcode should clone the distribution repository and download the binaries.
+3. Choose "Next". Xcode should clone the distribution repository and download the binaries.
+
+There is a an open bounty to extend this Getting Started guide ([#809](https://github.com/maplibre/maplibre-native/issues/809)). In the meantime, refer to one of these external guides:
+
+- [Get Started with MapLibre GL Native for iOS using SwiftUI](https://docs.maptiler.com/maplibre-gl-native-ios/ios-swiftui-basic-get-started/)
+- [Get Started With MapLibre GL Native for iOS using UIKit](https://docs.maptiler.com/maplibre-gl-native-ios/ios-uikit-basic-get-started/)
+
+## Developing
+
+### CMake
+
+The main build tool generator supported by MapLibre Native is CMake. There is a `Makefile` which calls CMake and `xcodebuild` under the hood to complete various development tasks, including building with various kinds of configurations and running tests. This `Makefile` can also can set up an Xcode project for MapLibre Native development by copying a `.xcodeproj` file part of the source tree and combining that with the output of CMake.
+
+To set up an Xcode project and open Xcode, use the following command.
+
+```
+make iproj
+```
+
+### Bazel
+
+The above setup is quite fragile and relies on the `.xcodeproj` files part of the source tree (making changes hard to review). We are looking into a better way to set up an Xcode project for MapLibre Native iOS development. As of May 2023 we are experimenting with [Bazel](https://bazel.build/) together with [rules_xcodeproj](https://github.com/MobileNativeFoundation/rules_xcodeproj). Please [share your experiences](https://github.com/maplibre/maplibre-native/discussions/1145).
+
+You need to install bazelisk, which is a wrapper around Bazel which ensures that the version specified in `.bazelversion` is used.
+
+```
+brew install bazelisk
+```
+
+Next, you can generate an Xcode project for MapLibre Native development using:
+
+```
+bazel run //platform/ios:xcodeproj
+```
+
+You can now open `platform/ios/MapLibre.xcodeproj` with Xcode to get started.
+
+It is also possible to build and run the test application in a simulator from the command line without opening Xcode.
+
+```
+bazel run //platform/ios:App
+```
 
 ## Documentation
 
 - [MapLibre Native for iOS API Reference](https://maplibre.org/maplibre-native/ios/api/)
-
-## Contributing
-
-See [`CONTRIBUTING.md`](./CONTRIBUTING.md).