From 8633f0fd5942688279c9c29b62bdacb1b216f968 Mon Sep 17 00:00:00 2001 From: Jordan Kiley Date: Tue, 22 Oct 2019 10:45:09 -0700 Subject: [PATCH] [WIP] Updating links and docs for new repo (#20) --- CONTRIBUTING.md | 6 ++---- INSTALL.md | 4 ---- README.md | 18 ++++-------------- platform/darwin/README.md | 4 ++-- platform/ios/INSTALL.md | 4 ++-- .../Mapbox-iOS-SDK-snapshot-dynamic.podspec | 2 +- platform/ios/Mapbox-iOS-SDK-stripped.podspec | 2 +- platform/ios/Mapbox-iOS-SDK.podspec | 2 +- platform/ios/README.md | 2 +- platform/ios/docs/pod-README.md | 8 ++++---- platform/ios/jazzy.yml | 4 ++-- platform/ios/scripts/document.sh | 2 +- .../scripts/install-packaging-dependencies.sh | 2 +- .../ios/scripts/release-notes-github.md.ejs | 4 ++-- .../ios/scripts/release-notes-jazzy.md.ejs | 4 ++-- platform/macos/INSTALL.md | 4 ++-- .../macos/Mapbox-macOS-SDK-symbols.podspec | 2 +- platform/macos/Mapbox-macOS-SDK.podspec | 2 +- platform/macos/README.md | 2 +- platform/macos/docs/doc-README.md | 6 +++--- platform/macos/docs/pod-README.md | 8 ++++---- platform/macos/jazzy.yml | 4 ++-- platform/macos/scripts/document.sh | 6 +++--- 23 files changed, 43 insertions(+), 59 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9b1f03f88..63ac3176c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,15 +6,13 @@ If you want to contribute code: 1. Please familiarize yourself with the [install process](INSTALL.md). -1. Ensure that existing [pull requests](https://github.com/mapbox/mapbox-gl-native/pulls) and [issues](https://github.com/mapbox/mapbox-gl-native/issues) don’t already cover your contribution or question. +1. Ensure that existing [pull requests](https://github.com/mapbox/mapbox-gl-native-ios/pulls) and [issues](https://github.com/mapbox/mapbox-gl-native-ios/issues) don’t already cover your contribution or question. 1. Pull requests are gladly accepted. If there are any changes that developers using one of the GL SDKs should be aware of, please update the **master** section of the relevant changelog(s): - * [Mapbox Maps SDK for Android](platform/android/CHANGELOG.md) * [Mapbox Maps SDK for iOS](platform/ios/CHANGELOG.md) * [Mapbox Maps SDK for macOS](platform/macos/CHANGELOG.md) - * [node-mapbox-gl-native](platform/node/CHANGELOG.md) -1. Prefix your commit messages with the platform(s) your changes affect: `[core]`, `[android]`, `[ios]`, `[macos]`, `[node]`, or `[qt]`. +1. Prefix your commit messages with the platform(s) your changes affect: `[ios]` or `[macos]`. Please note the special instructions for contributing new source code files, asset files, or user-facing strings to the [iOS SDK](platform/ios/DEVELOPING.md#contributing) or [macOS SDK](platform/macos/DEVELOPING.md#contributing). diff --git a/INSTALL.md b/INSTALL.md index 463d199d10..ff7d8a23be 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -7,9 +7,5 @@ that you can download instantly and get started with fast](https://www.mapbox.co If you're certain you need to build from source, rather than using a prebuilt SDK, please refer to the installation instructions for the platform of interest: -* [Mapbox Maps SDK for Android](platform/android/README.md) * [Mapbox Maps SDK for iOS](platform/ios/INSTALL.md) * [Mapbox Maps SDK for macOS](platform/macos/INSTALL.md) -* [Mapbox Maps SDK for Qt](platform/qt/README.md) -* [Mapbox GL Native on Linux](platform/linux/README.md) -* [node-mapbox-gl-native](platform/node/DEVELOPING.md) diff --git a/README.md b/README.md index d125fc53c8..2189106d77 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,11 @@ -# Mapbox GL Native +# Mapbox Maps SDKs for iOS and macOS -A library for embedding interactive, customizable vector maps into native applications on multiple platforms. It takes stylesheets that conform to the [Mapbox Style Specification](https://github.com/mapbox/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://github.com/mapbox/vector-tile-spec), and renders them using OpenGL. [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) is the WebGL-based counterpart, designed for use on the Web. - -## The Mapbox GL ecosystem - -This repository hosts the cross-platform Mapbox GL Native library, plus convenient SDKs for several platforms. The cross-platform library comes with a [GLFW](https://github.com/glfw/glfw)-based demo application for Ubuntu Linux and macOS. The SDKs target the usual languages on their respective platforms: +The Mapbox Maps SDK for iOS 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 [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-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 [Mapbox GL Native](https://github.com/mapbox/mapbox-gl-native) library. | SDK | Languages | Build status | | --------------------------------------- | ---------------------------------- | ---------------------------------------- | -| [Mapbox GL Native](INSTALL.md) | C++14 | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [![Coverage Status](https://codecov.io/gh/mapbox/mapbox-gl-native/branch/master/graph/badge.svg)](https://codecov.io/gh/mapbox/mapbox-gl-native) | -| [Mapbox Maps SDK for Android](platform/android/) | Java | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for iOS](platform/ios/) | Objective-C or Swift | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for macOS](platform/macos/) | Objective-C, Swift, or AppleScript | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [node-mapbox-gl-native](platform/node/) | Node.js | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for Qt](platform/qt) | C++03 | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [![AppVeyor CI build status](https://ci.appveyor.com/api/projects/status/3q12kbcooc6df8uc?svg=true)](https://ci.appveyor.com/project/Mapbox/mapbox-gl-native) | - -[Additional Mapbox GL Native–based libraries](https://wiki.openstreetmap.org/wiki/Mapbox_GL#Libraries) for **hybrid applications** are developed outside of this repository. If your platform or hybrid application framework isn’t listed there, consider embedding [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) using the standard Web capabilities on your platform. +| [Mapbox Maps SDK for iOS](platform/ios/) | Objective-C or Swift | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native-ios.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native-ios/tree/master) | +| [Mapbox Maps SDK for macOS](platform/macos/) | Objective-C, Swift, or AppleScript | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native-ios.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native-ios/tree/master) | ## License diff --git a/platform/darwin/README.md b/platform/darwin/README.md index 349c9a00c0..d98674c224 100644 --- a/platform/darwin/README.md +++ b/platform/darwin/README.md @@ -2,8 +2,8 @@ The code in the Darwin platform targets Apple platforms but is not specific to iOS or macOS. This code is not distributed as an SDK in itself, but is required -by the [Mapbox iOS SDK](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/ios) -and [Mapbox macOS SDK](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/macos). +by the [Mapbox iOS SDK](https://github.com/mapbox/mapbox-gl-native-ios/tree/master/platform/ios) +and [Mapbox macOS SDK](https://github.com/mapbox/mapbox-gl-native-ios/tree/master/platform/macos). These files depend on the Foundation and Core Foundation frameworks but do not depend on iOS- or macOS–specific frameworks, such as UIKit or AppKit. Any diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md index 1d0d7dc647..9feea010bc 100644 --- a/platform/ios/INSTALL.md +++ b/platform/ios/INSTALL.md @@ -40,7 +40,7 @@ Before building, follow these steps to install prerequisites: 1. Clone the git repository: ``` - git clone https://github.com/mapbox/mapbox-gl-native.git + git clone https://github.com/mapbox/mapbox-gl-native-ios.git cd mapbox-gl-native ``` Note that this repository uses Git submodules. They'll be automatically checked out when you first run a `make` command, @@ -119,7 +119,7 @@ pod 'Mapbox-iOS-SDK', '~> x.x.x-alpha.1' To test a snapshot dynamic framework build, update your app’s `Podfile` to point to: ```rb -pod 'Mapbox-iOS-SDK-snapshot-dynamic', podspec: 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec' +pod 'Mapbox-iOS-SDK-snapshot-dynamic', podspec: 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native-ios/master/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec' ``` ##### Using your own build with CocoaPods diff --git a/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec b/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec index 84ce50bb4f..9eb7dde293 100644 --- a/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec +++ b/platform/ios/Mapbox-iOS-SDK-snapshot-dynamic.podspec @@ -15,7 +15,7 @@ Pod::Spec.new do |m| m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { - :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-snapshot-dynamic.zip", + :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native-ios/ios/builds/mapbox-ios-sdk-snapshot-dynamic.zip", :flatten => true } diff --git a/platform/ios/Mapbox-iOS-SDK-stripped.podspec b/platform/ios/Mapbox-iOS-SDK-stripped.podspec index 51d7087c63..07011deb22 100644 --- a/platform/ios/Mapbox-iOS-SDK-stripped.podspec +++ b/platform/ios/Mapbox-iOS-SDK-stripped.podspec @@ -15,7 +15,7 @@ Pod::Spec.new do |m| m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { - :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", + :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native-ios/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", :flatten => true } diff --git a/platform/ios/Mapbox-iOS-SDK.podspec b/platform/ios/Mapbox-iOS-SDK.podspec index c4f686f060..46bd4a3d19 100644 --- a/platform/ios/Mapbox-iOS-SDK.podspec +++ b/platform/ios/Mapbox-iOS-SDK.podspec @@ -15,7 +15,7 @@ Pod::Spec.new do |m| m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { - :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", + :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native-ios/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", :flatten => true } diff --git a/platform/ios/README.md b/platform/ios/README.md index fe6f3be95d..9fd43fda5a 100644 --- a/platform/ios/README.md +++ b/platform/ios/README.md @@ -2,7 +2,7 @@ [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) -A library based on [Mapbox GL Native](../../README.md) for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS using Objective-C, Swift, or Interface Builder. +A library based on [Mapbox GL Native](https://github.com/mapbox/mapbox-gl-native/blob/master/README.md) for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS using Objective-C, Swift, or Interface Builder. This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, prebuilt release instead; see the [Mapbox Maps SDK for iOS website](https://docs.mapbox.com/ios/maps/) for installation instructions. diff --git a/platform/ios/docs/pod-README.md b/platform/ios/docs/pod-README.md index 8a3080055d..dfccff8dbb 100644 --- a/platform/ios/docs/pod-README.md +++ b/platform/ios/docs/pod-README.md @@ -2,13 +2,13 @@ The Mapbox Maps SDK for iOS 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 [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-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. -For more information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/) and the [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/CHANGELOG.md) online. +For more information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/) and the [full changelog](https://github.com/mapbox/mapbox-gl-native-ios/blob/master/platform/ios/CHANGELOG.md) online. -[![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/ios/docs/img/screenshot.png)]() +[![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native-ios/master/platform/ios/docs/img/screenshot.png)]() ## Installation -The Mapbox Maps SDK for iOS may be installed as either a dynamic framework or a static framework. (To reduce the download size, the static framework is omitted from some distributions; you may need to download the full package from the [release page](https://github.com/mapbox/mapbox-gl-native/releases/).) +The Mapbox Maps SDK for iOS may be installed as either a dynamic framework or a static framework. (To reduce the download size, the static framework is omitted from some distributions; you may need to download the full package from the [release page](https://github.com/mapbox/mapbox-gl-native-ios/releases/).) Integrating the Mapbox Maps SDK for iOS requires Xcode 8.0 or higher. @@ -96,4 +96,4 @@ class ViewController: UIViewController { Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). -If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native/issues/). +If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native-ios/issues/). diff --git a/platform/ios/jazzy.yml b/platform/ios/jazzy.yml index f5d0040ea5..e850b97978 100644 --- a/platform/ios/jazzy.yml +++ b/platform/ios/jazzy.yml @@ -1,9 +1,9 @@ module: Mapbox author: Mapbox author_url: https://www.mapbox.com/ -github_url: https://github.com/mapbox/mapbox-gl-native +github_url: https://github.com/mapbox/mapbox-gl-native-ios dash_url: https://docs.mapbox.com/ios/docsets/Mapbox.xml -copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.' +copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native-ios/blob/master/LICENSE.md) for more details.' head: | diff --git a/platform/ios/scripts/document.sh b/platform/ios/scripts/document.sh index bb1c63dc6c..c44b5bf5b7 100755 --- a/platform/ios/scripts/document.sh +++ b/platform/ios/scripts/document.sh @@ -38,7 +38,7 @@ step "Generating jazzy docs for ${SHORT_VERSION}…" jazzy \ --config platform/ios/jazzy.yml \ --sdk iphonesimulator \ - --github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \ + --github-file-prefix https://github.com/mapbox/mapbox-gl-native-ios/tree/${BRANCH} \ --module-version ${SHORT_VERSION} \ --readme ${README} \ --documentation="platform/{darwin,ios}/docs/guides/*.md" \ diff --git a/platform/ios/scripts/install-packaging-dependencies.sh b/platform/ios/scripts/install-packaging-dependencies.sh index 558223bad4..6d63c97647 100755 --- a/platform/ios/scripts/install-packaging-dependencies.sh +++ b/platform/ios/scripts/install-packaging-dependencies.sh @@ -54,7 +54,7 @@ if [[ -z `which jazzy` || $(jazzy -v) != "jazzy version: ${JAZZY_VERSION}" ]]; t fi if [ -z `which jazzy` ]; then - echo "Unable to install jazzy ($JAZZY_VERSION). See https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/INSTALL.md" + echo "Unable to install jazzy ($JAZZY_VERSION). See https://github.com/mapbox/mapbox-gl-native-ios/blob/master/platform/ios/INSTALL.md" exit 1 fi else diff --git a/platform/ios/scripts/release-notes-github.md.ejs b/platform/ios/scripts/release-notes-github.md.ejs index 53c7c842fe..7598944215 100644 --- a/platform/ios/scripts/release-notes-github.md.ejs +++ b/platform/ios/scripts/release-notes-github.md.ejs @@ -1,9 +1,9 @@ -[Changes](https://github.com/mapbox/mapbox-gl-native/compare/ios-v<%-PREVIOUSVERSION%>...ios-v<%-CURRENTVERSION%>) since [Mapbox Maps SDK for iOS v<%-PREVIOUSVERSION%>](https://github.com/mapbox/mapbox-gl-native/releases/tag/ios-v<%-PREVIOUSVERSION%>): +[Changes](https://github.com/mapbox/mapbox-gl-native-ios/compare/ios-v<%-PREVIOUSVERSION%>...ios-v<%-CURRENTVERSION%>) since [Mapbox Maps SDK for iOS v<%-PREVIOUSVERSION%>](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v<%-PREVIOUSVERSION%>): <%-CHANGELOG-%> <% if (isPrerelease) { %> -To install this pre-release via a dependency manager, see our [CocoaPods](https://github.com/mapbox/mapbox-gl-native/blob/ios-v<%-CURRENTVERSION%>/platform/ios/INSTALL.md#CocoaPods) or [Carthage](https://github.com/mapbox/mapbox-gl-native/blob/ios-v<%-CURRENTVERSION%>/platform/ios/INSTALL.md#Carthage) instructions. +To install this pre-release via a dependency manager, see our [CocoaPods](https://github.com/mapbox/mapbox-gl-native-ios/blob/ios-v<%-CURRENTVERSION%>/platform/ios/INSTALL.md#CocoaPods) or [Carthage](https://github.com/mapbox/mapbox-gl-native-ios/blob/ios-v<%-CURRENTVERSION%>/platform/ios/INSTALL.md#Carthage) instructions. <% } -%> Documentation is [available online](https://www.mapbox.com/ios-sdk/api/<%-CURRENTVERSION%>/) or as part of the download. diff --git a/platform/ios/scripts/release-notes-jazzy.md.ejs b/platform/ios/scripts/release-notes-jazzy.md.ejs index 12b7480a2b..a609984b34 100644 --- a/platform/ios/scripts/release-notes-jazzy.md.ejs +++ b/platform/ios/scripts/release-notes-jazzy.md.ejs @@ -6,7 +6,7 @@ The Mapbox Maps SDK for iOS is an open-source framework for embedding interactiv For setup information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/). For detailed usage instructions, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). -If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native/issues/). +If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native-ios/issues/). ## Changes in version <%-CURRENTVERSION%> @@ -20,4 +20,4 @@ If you have any questions, please see [our help page](https://www.mapbox.com/hel <%-release.changelog%> <% }) -%> -See the [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/ios-v<%-CURRENTVERSION%>/platform/ios/CHANGELOG.md) for previous releases. +See the [full changelog](https://github.com/mapbox/mapbox-gl-native-ios/blob/ios-v<%-CURRENTVERSION%>/platform/ios/CHANGELOG.md) for previous releases. diff --git a/platform/macos/INSTALL.md b/platform/macos/INSTALL.md index 265039c7b5..7c24fce5e3 100644 --- a/platform/macos/INSTALL.md +++ b/platform/macos/INSTALL.md @@ -4,7 +4,7 @@ This document explains how to build a development version of the Mapbox Maps SDK ### Requirements -The Mapbox Maps SDK for macOS requires the macOS 10.11.0 SDK (or above) and Xcode 9.0 (or above). To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. +The Mapbox Maps SDK for macOS requires the macOS 10.11.0 SDK (or above) and Xcode 9.0 (or above). To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native-ios/releases) page. Before building, follow these steps to install prerequisites: @@ -30,7 +30,7 @@ To build the SDK from source: 1. Clone the git repository: ``` - git clone https://github.com/mapbox/mapbox-gl-native.git + git clone https://github.com/mapbox/mapbox-gl-native-ios.git cd mapbox-gl-native ``` Note that this repository uses Git submodules. They'll be automatically checked out when you first run a `make` command, diff --git a/platform/macos/Mapbox-macOS-SDK-symbols.podspec b/platform/macos/Mapbox-macOS-SDK-symbols.podspec index 4d21db99fb..344a321fa2 100644 --- a/platform/macos/Mapbox-macOS-SDK-symbols.podspec +++ b/platform/macos/Mapbox-macOS-SDK-symbols.podspec @@ -15,7 +15,7 @@ Pod::Spec.new do |m| m.documentation_url = 'https://mapbox.github.io/mapbox-gl-native/macos/' m.source = { - :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip", + :http => "https://github.com/mapbox/mapbox-gl-native-ios/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip", :flatten => true } diff --git a/platform/macos/Mapbox-macOS-SDK.podspec b/platform/macos/Mapbox-macOS-SDK.podspec index 876b354b4f..fe24d15baf 100644 --- a/platform/macos/Mapbox-macOS-SDK.podspec +++ b/platform/macos/Mapbox-macOS-SDK.podspec @@ -15,7 +15,7 @@ Pod::Spec.new do |m| m.documentation_url = 'https://mapbox.github.io/mapbox-gl-native/macos/' m.source = { - :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip", + :http => "https://github.com/mapbox/mapbox-gl-native-ios/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip", :flatten => true } diff --git a/platform/macos/README.md b/platform/macos/README.md index 7f80d0f320..8c856ae395 100644 --- a/platform/macos/README.md +++ b/platform/macos/README.md @@ -1,6 +1,6 @@ # [Mapbox Maps SDK for macOS](https://mapbox.github.io/mapbox-gl-native/macos/) -[![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) +[![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native-ios.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native-ios/tree/master) Put interactive, scalable world maps into your native Cocoa application with the Mapbox Maps SDK for macOS. diff --git a/platform/macos/docs/doc-README.md b/platform/macos/docs/doc-README.md index 8ce2df39a4..758d67f85e 100644 --- a/platform/macos/docs/doc-README.md +++ b/platform/macos/docs/doc-README.md @@ -1,9 +1,9 @@ -# [Mapbox Maps SDK for macOS](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/macos/) +# [Mapbox Maps SDK for macOS](https://github.com/mapbox/mapbox-gl-native-ios/tree/master/platform/macos/) The Mapbox Maps SDK for macOS is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa applications on macOS 10.11.0 and above using Objective-C, Swift, Interface Builder, or AppleScript. The SDK takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-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. ![](img/screenshot.jpg) -For setup information, consult the README.md that comes with this documentation. For further instructions, consult the [Mapbox Maps SDK for macOS documentation](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) has [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) that apply to the macOS SDK with few differences, mostly around unimplemented features like user location tracking. A [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/macos/CHANGELOG.md) is also available. +For setup information, consult the README.md that comes with this documentation. For further instructions, consult the [Mapbox Maps SDK for macOS documentation](https://mapbox.github.io/mapbox-gl-native-ios/macos/). The [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) has [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) that apply to the macOS SDK with few differences, mostly around unimplemented features like user location tracking. A [full changelog](https://github.com/mapbox/mapbox-gl-native-ios/blob/master/platform/macos/CHANGELOG.md) is also available. -Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, [bug reports and pull requests](https://github.com/mapbox/mapbox-gl-native/issues/) are certainly welcome. +Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, [bug reports and pull requests](https://github.com/mapbox/mapbox-gl-native-ios/issues/) are certainly welcome. diff --git a/platform/macos/docs/pod-README.md b/platform/macos/docs/pod-README.md index 6fd0926443..b2588da603 100644 --- a/platform/macos/docs/pod-README.md +++ b/platform/macos/docs/pod-README.md @@ -1,4 +1,4 @@ -# [Mapbox Maps SDK for macOS](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/macos/) +# [Mapbox Maps SDK for macOS](https://github.com/mapbox/mapbox-gl-native-ios/tree/master/platform/macos/) Put interactive, scalable world maps into your native Cocoa application with the open-source Mapbox Maps SDK for macOS. @@ -18,7 +18,7 @@ There are three ways to install the Mapbox Maps SDK for macOS: ### Manually -1. Download the [latest Mapbox Maps SDK for macOS release](https://github.com/mapbox/mapbox-gl-native/releases/) from GitHub – look for a release that begins with “macos-”. +1. Download the [latest Mapbox Maps SDK for macOS release](https://github.com/mapbox/mapbox-gl-native-ios/releases/) from GitHub – look for a release that begins with “macos-”. 1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. @@ -27,7 +27,7 @@ There are three ways to install the Mapbox Maps SDK for macOS: The Mapbox Maps SDK for macOS is a binary-only dependency, so you’ll need Carthage 0.19 or above. In your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#binary-only-frameworks), specify this dependency (plus an optional version requirement): ``` -binary "https://mapbox.github.io/mapbox-gl-native/macos/Mapbox-macOS-SDK.json" +binary "https://mapbox.github.io/mapbox-gl-native-ios/macos/Mapbox-macOS-SDK.json" ``` After running `carthage update`, you’ll find Mapbox.framework in the Carthage/Build/ folder. Follow [these instructions](https://github.com/Carthage/Carthage#if-youre-building-for-os-x) to integrate it into your project. @@ -95,4 +95,4 @@ end script Full API documentation is included in this package, within the `documentation` folder, and [online](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/) has [API documentation](https://docs.mapbox.com/ios/api/maps/) and [online examples](https://docs.mapbox.com/ios/maps/examples/) that apply to the Mapbox Maps SDK for macOS with few differences, mostly around unimplemented features like user location tracking. -Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, [bug reports and pull requests](https://github.com/mapbox/mapbox-gl-native/issues/) are certainly welcome. +Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, [bug reports and pull requests](https://github.com/mapbox/mapbox-gl-native-ios/issues/) are certainly welcome. diff --git a/platform/macos/jazzy.yml b/platform/macos/jazzy.yml index 381e6f8b33..d9c0a93d13 100644 --- a/platform/macos/jazzy.yml +++ b/platform/macos/jazzy.yml @@ -1,9 +1,9 @@ module: Mapbox author: Mapbox author_url: https://www.mapbox.com/ -github_url: https://github.com/mapbox/mapbox-gl-native +github_url: https://github.com/mapbox/mapbox-gl-native-ios dash_url: https://mapbox.github.io/mapbox-gl-native/macos/docsets/Mapbox.xml -copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.' +copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native-ios/blob/master/LICENSE.md) for more details.' head: | diff --git a/platform/macos/scripts/document.sh b/platform/macos/scripts/document.sh index 8d8d1c7bf2..29e0ef4b99 100755 --- a/platform/macos/scripts/document.sh +++ b/platform/macos/scripts/document.sh @@ -8,7 +8,7 @@ if [ -z `which jazzy` ]; then echo "Installing jazzy…" gem install jazzy if [ -z `which jazzy` ]; then - echo "Unable to install jazzy. See https://github.com/mapbox/mapbox-gl-native/blob/master/platform/macos/INSTALL.md" + echo "Unable to install jazzy. See https://github.com/mapbox/mapbox-gl-native-ios/blob/master/platform/macos/INSTALL.md" exit 1 fi fi @@ -24,13 +24,13 @@ mkdir -p /tmp/mbgl/ README=/tmp/mbgl/README.md if [[ ${STANDALONE:-} ]]; then cp platform/macos/docs/pod-README.md "${README}" - perl -pi -e 's|https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/macos/docs/||' \ + perl -pi -e 's|https://raw.githubusercontent.com/mapbox/mapbox-gl-native-ios/master/platform/macos/docs/||' \ "${README}" else cp platform/macos/docs/doc-README.md "${README}" fi # http://stackoverflow.com/a/4858011/4585461 -echo "## Changes in [version ${RELEASE_VERSION}](https://github.com/mapbox/mapbox-gl-native/releases/tag/${BRANCH})" >> "${README}" +echo "## Changes in [version ${RELEASE_VERSION}](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/${BRANCH})" >> "${README}" sed -n -e '/^## /{' -e ':a' -e 'n' -e '/^## /q' -e 'p' -e 'ba' -e '}' platform/macos/CHANGELOG.md >> "${README}" rm -rf ${OUTPUT}