Skip to content

Commit

Permalink
Merge pull request #175 from heremaps/ESD-810-Update-Product-Names
Browse files Browse the repository at this point in the history
ESD-810: Update Product Names
  • Loading branch information
ogunreku authored May 18, 2020
2 parents 09a4ea3 + b14e2d8 commit f933cd3
Show file tree
Hide file tree
Showing 8 changed files with 94 additions and 94 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to the HERE Mobile SDK UI Kit
# Contributing to the HERE Mobile SDK UI Kit (MSDKUI)

Thank you for your interest in contributing to this open source project. Every great project comes with great quality. There are many ways to contribute on this project, whether you want to create an issue, submit bug reports, improve the documentation or add new UI components - we are happy to see your pull requests.

Expand Down
20 changes: 10 additions & 10 deletions Documentation/Guides/ContributionGuide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# MSDKUI Contribution Guide
# HERE Mobile SDK UI Kit (MSDKUI) Contribution Guide

This guide is for developers who want to contribute to the MSDKUI codebase, build the MSDKUI library, or run the demo application on their local machines. For using the `MSDKUILib.aar` on your own project, or running the accompanying example apps, please check the [QuickStart](QuickStart.md) guide.

## Contents

- [Getting the code](#getting-the-code)
- [See available Gradle tasks](#see-available-gradle-tasks)
- [Building the HERE UI Kit library](#building-the-here-ui-kit-library)
- [Building the MSDKUI library](#building-the-msdkui-library)
- [Building the MSDKUI API Reference from the command line](#building-the-msdkui-api-reference-from-the-command-line)
- [Running unit tests for the MSDKUILib](#running-unit-tests-for-the-msdkuilib)
- [Generating a unit test coverage report](#generating-a-unit-test-coverage-report)
Expand All @@ -16,7 +16,7 @@ This guide is for developers who want to contribute to the MSDKUI codebase, buil
- [Running unit tests for the MDKUIApp](#running-unit-tests-for-the-mdkuiapp)
- [Generating a unit test coverage report](#generating-a-unit-test-coverage-report)
- [Running UI tests for the MDKUIApp](#running-ui-tests-for-the-mdkuiapp)
- [Optional: Building the HERE UI Kit Library and the Demo as part of one project](#optional-building-the-here-ui-kit-library-and-the-demo-as-part-of-one-project)
- [Optional: Building the MSDKUI Library and the Demo as part of one project](#optional-building-the-msdkui-library-and-the-demo-as-part-of-one-project)
- [Building the Dev app](#building-the-dev-app)
- [Commit policy](#commit-policy)
- [Writing Git commit messages](#writing-git-commit-messages)
Expand All @@ -38,11 +38,11 @@ The HERE SDK UI Kit for Android is built using Gradle. For an overview of the av
- ./gradlew task from MSDKUIKIT folder to see all lib related tasks
- ./gradlew task from MSDKUIDemo folder to see all Demo app related tasks

## Building the HERE UI Kit library
## Building the MSDKUI library

The easiest way to build the HERE Mobile SDK UI Kit library (MSDKUILib) is using the command line:
The easiest way to build the MSDKUI library (MSDKUILib) is using the command line:
- Put the `HERE-sdk.aar` file from your HERE SDK package to _MSDKUIKit/libs/_.
- Build the HERE Mobile SDK UI Kit library via Gradle. Navigate to the _MSDKUIKit_ folder and execute: `./gradlew clean :MSDKUILib:assembleRelease`.
- Build the MSDKUI library via Gradle. Navigate to the _MSDKUIKit_ folder and execute: `./gradlew clean :MSDKUILib:assembleRelease`.

>**Note:** Please, make sure to set `ANDROID_HOME` to your environment `PATH` variable. It should point to the location where you have installed the Android SDK.
Expand Down Expand Up @@ -91,9 +91,9 @@ When you register on [developer.here.com](https://developer.here.com), the regis

### Building and Running the Demo

In order to build and to run the demo app with Android Studio, you need to integrate the HERE Mobile SDK (Premium) version 3.15. Additionally, you need to integrate the HERE Mobile SDK UI Kit library.
In order to build and to run the demo app with Android Studio, you need to integrate the HERE Mobile SDK (Premium) version 3.15. Additionally, you need to integrate the MSDKUI library.

- Put the HERE-sdk.aar file from your HERE SDK package and the HERE UI Kit library to _MSDKUIDemo/libs/_.
- Put the HERE-sdk.aar file from your HERE SDK package and the MSDKUI library to _MSDKUIDemo/libs/_.
- Open and build the project located at _MSDKUIDemo/_ in Android Studio.
- Run it on a device or emulator of your choice.

Expand All @@ -117,7 +117,7 @@ Switch to command line and navigate to the _MSDKUIDemo_ folder. Execute: `./grad

>**Note:** Alternatively, you can also run the UI tests from within Android Studio by right clicking on a specific test or the _androidTest_ subfolder and clicking "Run Tests". You can also directly select the Gradle Task: `MSDKUIApp -> Tasks -> build -> assembleAndroidTest` (right-click and run).
### Optional: Building the HERE UI Kit Library and the Demo as part of one project
### Optional: Building the MSDKUI Library and the Demo as part of one project

Usually, it should be sufficient to keep library and Demo project separated. If you are planning to contribute to the Demo app - or to test your new components as part of the Demo app - it may be convenient to build both as part of one Android Studio project.

Expand All @@ -142,7 +142,7 @@ classpath 'org.jfrog.buildinfo:build-info-extractor-gradle:4.4.15'

This project includes a Dev application, which is designed to display MSDKUI views in their raw form. While the Demo app offers a polished experience of the MSDKUI components, it doesn't show all possible states of a view.

1. Put the HERE-sdk.aar file from your HERE Mobile SDK package _and_ the HERE MSDKUI library to `MSDKUIDev/libs/`. Make sure the library is named "MSDKUILib.aar" to match the dependencies in the app's `build.gradle` file.
1. Put the HERE-sdk.aar file from your HERE Mobile SDK package _and_ the MSDKUI library to `MSDKUIDev/libs/`. Make sure the library is named "MSDKUILib.aar" to match the dependencies in the app's `build.gradle` file.
2. Open and build the project located at `MSDKUIDev/` in Android Studio.
3. Run it on a device or an emulator of your choice.

Expand Down
Loading

0 comments on commit f933cd3

Please sign in to comment.