Skip to content
This repository has been archived by the owner on May 9, 2018. It is now read-only.

product quest #667

Merged
merged 4 commits into from
Aug 22, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
CONTRIBUTING
------------

If you have a usage question, please email help-at-mapbox.com.

If you want to contribute code:

1. In past, for things that are generally useful to mapping libraries, we encouraged contributions to the upstream project [Alpstein/route-me](http://github.com/alpstein/route-me), from which this project is derived. But that project is no longer active, so you can contribute pull here.
**Please note that this legacy tree of the Mapbox iOS SDK is deprecated. As such, this project is not under active development. The `2.0.0` and above tree, based on code located at https://github.com/mapbox/mapbox-gl-native/, is a complete rewrite based on OpenGL ES and vector map rendering.**

1. Please familiarize yourself with work in [`mapbox-gl-native`](https://github.com/mapbox/mapbox-gl-native), which will eventually be the successor to this codebase. That framework solves lots of problems inherent to a Core Graphics-based framework like this one such as performance and flexibility.

1. Fork and submit a pull request **against the `develop` branch** so that we can review, discuss, and possibly integrate your code.
If you have a usage question, please email help-at-mapbox.com.
8 changes: 4 additions & 4 deletions Mapbox-iOS-SDK.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Pod::Spec.new do |m|

m.summary = 'An open source toolset for building mapping applications for iOS devices.'
m.description = 'An open source toolset for building mapping applications for iOS devices with great flexibility for visual styling, offline use, and customizability.'
m.homepage = 'https://mapbox.com/mapbox-ios-sdk'
m.homepage = 'https://mapbox.com/mapbox-ios-sdk-legacy'
m.license = 'BSD'
m.author = { 'Mapbox' => '[email protected]' }
m.screenshot = 'https://raw.github.com/mapbox/mapbox-ios-sdk/packaging/screenshot.png'
m.screenshot = 'https://raw.github.com/mapbox/mapbox-ios-sdk-legacy/packaging/screenshot.png'
m.social_media_url = 'https://twitter.com/Mapbox'

m.source = {
:git => 'https://github.com/mapbox/mapbox-ios-sdk.git',
:git => 'https://github.com/mapbox/mapbox-ios-sdk-legacy.git',
:tag => m.version.to_s
}

Expand Down Expand Up @@ -59,7 +59,7 @@ Pod::Spec.new do |m|
'Mapbox' => 'MapView/Map/Resources/*'
}

m.documentation_url = 'https://www.mapbox.com/mapbox-ios-sdk'
m.documentation_url = 'https://www.mapbox.com/mapbox-ios-sdk-legacy'

m.frameworks = 'CoreGraphics', 'CoreLocation', 'Foundation', 'QuartzCore', 'UIKit'

Expand Down
23 changes: 9 additions & 14 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Mapbox iOS SDK
--------------

**This tree of the Mapbox iOS SDK is deprecated in favor of the [Mapbox GL](http://github.com/mapbox/mapbox-gl-native)-based version 2.0.0 and above. The future of Mapbox maps is vector rendering, and 2.0.0 is a rewrite based on OpenGL ES and vector rendering.**

Based on the Route-Me iOS map library (Alpstein fork) with [Mapbox](http://mapbox.com) customizations.

Requires iOS 5 or greater (includes iOS 7+ support at runtime), Xcode 5.0 or greater, and ARC.

[![](https://raw.github.com/mapbox/mapbox-ios-sdk/packaging/screenshot.png)]()
[![](https://raw.github.com/mapbox/mapbox-ios-sdk-legacy/packaging/screenshot.png)]()

Major differences from [Alpstein fork of Route-Me](https://github.com/Alpstein/route-me):

Expand All @@ -28,11 +30,6 @@ Major differences from [Alpstein fork of Route-Me](https://github.com/Alpstein/r
* A few added defaults for convenience.
* Improved documentation.

Mapbox GL
---------

You should consider using [Mapbox GL](https://www.mapbox.com/mapbox-gl-ios/), the vector-based future of our rendering technology that will replace the Mapbox iOS SDK. We are working to provide a clear upgrade path between existing toolsets and GL as it matures. Read more in the [Mapbox GL iOS FAQ](https://github.com/mapbox/mapbox-gl-native/blob/master/ios/FAQ.md).


Route-Me
--------
Expand All @@ -52,9 +49,9 @@ There are three ways that you can install the SDK, depending upon your needs:
1. Use the [static library](http://mapbox-ios-sdk.s3.amazonaws.com/index.html). Link it in your project, add `#import <Mapbox/Mapbox.h>`, and additionally, include the `-ObjC` linker flag.
1. Install via [CocoaPods](http://cocoapods.org).

More detailed information on the installation options is available in the [SDK guide](http://mapbox.com/mapbox-ios-sdk/).
More detailed information on the installation options is available in the [SDK guide](http://mapbox.com/mapbox-ios-sdk-legacy/).

The two main branches of the GitHub repository are pretty self-explanatory: `release` and `develop`. When we tag a [release](https://github.com/mapbox/mapbox-ios-sdk/tags), we also merge `develop` over to `release`, except in the case of minor point releases (e.g., `0.4.2`), where we might just bring over a fix or two from `develop`.
The two main branches of the GitHub repository are pretty self-explanatory: `release` and `develop`. When we tag a [release](https://github.com/mapbox/mapbox-ios-sdk-legacy/tags), we also merge `develop` over to `release`, except in the case of minor point releases (e.g., `0.4.2`), where we might just bring over a fix or two from `develop`.

Then, update the submodules:

Expand All @@ -67,7 +64,7 @@ Some example apps showing usage of the SDK (with screenshots):
* [Mapbox Me](https://github.com/mapbox/mapbox-me) - user location services and terrain toggling
* [Weekend Picks](https://github.com/mapbox/weekend-picks-template-ios) - markers and data

More documentation and examples are available here: http://mapbox.com/mapbox-ios-sdk/
More documentation and examples are available here: http://mapbox.com/mapbox-ios-sdk-legacy/

There are two subdirectories - MapView and Proj4. Proj4 is a support library used to do map projections. The MapView project contains only the Route-Me map library.

Expand All @@ -76,15 +73,13 @@ See License.txt for license details. In any app that uses this SDK, include the
News, Support and Contributing
------------------------------

Complete API documentation is available [online](http://mapbox.com/mapbox-ios-sdk/api/) or as an [Xcode docset Atom feed](http://mapbox.com/mapbox-ios-sdk/Docs/publish/docset.atom).

The Mapbox iOS SDK has a [support resource](http://support.mapbox.com/discussions/mapbox-ios-sdk) where you can open cases and browse other developers' discussions about use of the SDK.
Complete API documentation is available [online](http://mapbox.com/mapbox-ios-sdk-legacy/api/) or as an [Xcode docset Atom feed](http://mapbox.com/mapbox-ios-sdk-legacy/Docs/publish/docset.atom).

We have a [basic technical overview](http://mapbox.com/mapbox-ios-sdk/) along with the installation instructions.
We have a [basic technical overview](http://mapbox.com/mapbox-ios-sdk-legacy/) along with the installation instructions.

Mapbox has an IRC channel on `irc.freenode.net` in `#mapbox`.

To report bugs and help fix them, please use the [issue tracker](https://github.com/mapbox/mapbox-ios-sdk/issues).
To report bugs and help fix them, please use the [issue tracker](https://github.com/mapbox/mapbox-ios-sdk-legacy/issues).

Dependent Libraries
-------------------
Expand Down