From a4b83a439cfaf67c653999cfc6f89bfa3ef8551e Mon Sep 17 00:00:00 2001 From: John Firebaugh Date: Mon, 28 Mar 2016 19:34:58 -0700 Subject: [PATCH] [android] More strongly redirect non-contributors to the product website --- ...{INSTALL_LINUX.md => CONTRIBUTING_LINUX.md} | 2 +- .../{INSTALL_OSX.md => CONTRIBUTING_OSX.md} | 2 +- platform/android/README.md | 18 ++++++++++++------ 3 files changed, 14 insertions(+), 8 deletions(-) rename platform/android/{INSTALL_LINUX.md => CONTRIBUTING_LINUX.md} (97%) rename platform/android/{INSTALL_OSX.md => CONTRIBUTING_OSX.md} (98%) diff --git a/platform/android/INSTALL_LINUX.md b/platform/android/CONTRIBUTING_LINUX.md similarity index 97% rename from platform/android/INSTALL_LINUX.md rename to platform/android/CONTRIBUTING_LINUX.md index 353d0269d..00966cdb1 100644 --- a/platform/android/INSTALL_LINUX.md +++ b/platform/android/CONTRIBUTING_LINUX.md @@ -1,4 +1,4 @@ -# Developing for Android on Linux +# Contributing to the Android SDK on Linux Install a build dependencies: diff --git a/platform/android/INSTALL_OSX.md b/platform/android/CONTRIBUTING_OSX.md similarity index 98% rename from platform/android/INSTALL_OSX.md rename to platform/android/CONTRIBUTING_OSX.md index 00096ebc6..3154ac108 100644 --- a/platform/android/INSTALL_OSX.md +++ b/platform/android/CONTRIBUTING_OSX.md @@ -1,4 +1,4 @@ -# Installing the Mapbox Android SDK on OS X +# Contributing to the Android SDK on OS X Install Oracle JDK 7+ and Android Studio: diff --git a/platform/android/README.md b/platform/android/README.md index 135eb87a9..895cf8468 100644 --- a/platform/android/README.md +++ b/platform/android/README.md @@ -4,14 +4,20 @@ A library based on [Mapbox GL Native](../../README.md) for embedding interactive map views with scalable, customizable vector maps into Java applications on Android devices. -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 Android SDK website](https://www.mapbox.com/android-sdk/) for installation instructions. +**To install and use the Mapbox Android SDK in an application, see the [Mapbox Android SDK website](https://www.mapbox.com/android-sdk/).** -## Installing the SDK +[![](https://www.mapbox.com/android-sdk/images/splash.jpg)](https://www.mapbox.com/android-sdk/) -* [Installing the Mapbox Android SDK on Linux](INSTALL_LINUX.md) -* [Installing the Mapbox Android SDK on OS X](INSTALL_OSX.md) +## Contributing to the SDK -## Setting up the Android emulator +**These instructions are for developers interested in making code-level contributions to the SDK itself. If you instead want to use the SDK in your app, see above.** + +Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. + +* [Contributing on Linux](CONTRIBUTING_LINUX.md) +* [Contributing on OS X](CONTRIBUTING_OSX.md) + +### Setting up the Android emulator The Mapbox Android SDK requires Android 4.0.3+ (API level 15+). @@ -35,7 +41,7 @@ In Android Studio, create an x86 AVD (Android Virtual Device): Now when you run or debug the Android project you will see a window "Choose Device". Select your new AVD from drop down under "Launch emulator". If you select "Use same device for future launches" Android Studio will remember the selection and not ask again. -## Running Mapbox GL Native on a hardware Android device +### Running Mapbox GL Native on a hardware Android device The Mapbox Android SDK requires Android 4.0.3+ (API level 15+).