Skip to content

Commit

Permalink
Merge pull request #176 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 20, 2020
2 parents 05de099 + 6ab1ead commit 88ac3ec
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 90 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
8 changes: 4 additions & 4 deletions Documentation/API_Reference/Intro.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- This file is used when building the API Reference. -->

# HERE Mobile SDK UI Kit - API Reference for iOS
Browse the latest API reference for the HERE Mobile SDK UI Kit framework.
# HERE Mobile SDK UI Kit (MSDKUI) - API Reference for iOS
Browse the latest API reference for the HERE Mobile SDK UI Kit (MSDKUI) framework.

## More Documentation Resources
- Be sure to check out our _Quick Start_ tutorial to see how easy it is to integrate the HERE Mobile SDK UI Kit into your own apps. More information on how to use the HERE Mobile SDK UI Kit can be found in our _User Guide_.
- Be sure to check out our _Quick Start_ tutorial to see how easy it is to integrate the HERE Mobile SDK UI Kit (MSDKUI) into your own apps. More information on how to use the HERE Mobile SDK UI Kit (MSDKUI) can be found in our _User Guide_.
- _Release Notes_: All recent additions, more details about the current release and the differences to previous versions can be found in the _Release Notes_.
- You can find various _examples_ and _code snippets_ accompanying the Developer's Guide on GitHub, plus a more complex and fully functional _demo app_.

## Get in Touch
We are happy to hear your feedback. Please [contact us](https://developer.here.com/contact-us) for any questions, suggestions or improvements. Thank you for your using the HERE Mobile SDK UI Kit.
We are happy to hear your feedback. Please [contact us](https://developer.here.com/contact-us) for any questions, suggestions or improvements. Thank you for your using the HERE Mobile SDK UI Kit (MSDKUI).
2 changes: 1 addition & 1 deletion Documentation/Guides/ContributionGuide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 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 framework, or run the Demo application on their local machines. For using the `MSDKUI.framework` on your own project, or running the accompanying example apps, please check the [QuickStart](QuickStart.md) guide.

Expand Down
42 changes: 21 additions & 21 deletions Documentation/Guides/QuickStart.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Quick Start
Thank you for using the MSDKUI (HERE Mobile SDK UI Kit). In this Quick Start guide, we are going to introduce you to the HERE Mobile SDK UI Kit and show you how easy it is to get started. As a very first example, we'll also develop a "Hello HERE Mobile SDK UI Kit" iOS application as part of this guide. For more examples and in-depth information on how to work with the HERE Mobile SDK UI Kit framework, please refer to the [User Guide](UserGuide.md).
Thank you for using the HERE Mobile SDK UI Kit (MSDKUI). In this Quick Start guide, we are going to introduce you to the HERE Mobile SDK UI Kit (MSDKUI) and show you how easy it is to get started. As a very first example, we'll also develop a "Hello HERE Mobile SDK UI Kit" iOS application as part of this guide. For more examples and in-depth information on how to work with the HERE Mobile SDK UI Kit (MSDKUI) framework, please refer to the [User Guide](UserGuide.md).

## Contents
- [Quick Start](#quick-start)
- [Contents](#contents)
- [How to run the example apps](#how-to-run-the-example-apps)
- [How to run the Demo app](#how-to-run-the-demo-app)
- [Set up an Xcode iOS Project](#set-up-an-xcode-ios-project)
- [Integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit](#integrate-the-here-mobile-sdk-and-the-here-mobile-sdk-ui-kit)
- [Integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit (MSDKUI)](#integrate-the-here-mobile-sdk-and-the-here-mobile-sdk-ui-kit-msdkui)
- [What to do if you have already included the HERE Mobile SDK in an existing project?](#what-to-do-if-you-have-already-included-the-here-mobile-sdk-in-an-existing-project)
- [Can I integrate the HERE Mobile SDK UI Kit manually without CocoaPods?](#can-i-integrate-the-here-mobile-sdk-ui-kit-manually-without-cocoapods)
- [Can I integrate the HERE Mobile SDK UI Kit (MSDKUI) manually without CocoaPods?](#can-i-integrate-the-here-mobile-sdk-ui-kit-msdkui-manually-without-cocoapods)
- [Set your HERE Mobile SDK credentials](#set-your-here-mobile-sdk-credentials)
- [Add your first HERE Mobile SDK UI Kit component](#add-your-first-here-mobile-sdk-ui-kit-component)
- [Add your first HERE Mobile SDK UI Kit (MSDKUI) component](#add-your-first-here-mobile-sdk-ui-kit-msdkui-component)


## How to run the example apps
Expand All @@ -34,7 +34,7 @@ Along with the accompanying example apps and code snippets, we also provide a mo
If you want to build your own app, it may be useful to follow the guide below where we will develop step by step a first "Hello HERE Mobile SDK UI Kit" app in greater detail.

## Set up an Xcode iOS Project
Let's start by creating a new iOS app. If you want to integrate the HERE Mobile SDK UI Kit into an existing app, you can skip the step below, but please make sure to meet the [minimum requirements](../../README.md#ios-environment).
Let's start by creating a new iOS app. If you want to integrate the HERE Mobile SDK UI Kit (MSDKUI) into an existing app, you can skip the step below, but please make sure to meet the [minimum requirements](../../README.md#ios-environment).
If you are new to iOS development please follow the guides on [developer.apple.com](https://developer.apple.com/documentation/) to help you to get started with the first steps.

>The example project is called "HelloMSDKUI" and it can be found [here](../Guides_Examples).
Expand All @@ -45,18 +45,18 @@ For this Quick Start app, we have used Xcode 11.4 and Swift 5.2. Start Xcode and
- Provide a project name, e.g. "HelloMSDKUI" and select _Swift_ as language.
- Set a bundle identifier matching the one you have used to acquire your HERE credentials, e.g. "com.here.msdkui.example".
- After Xcode has prepared the project setup, make sure to set up your provisioning profile: _Project settings_ => _Signing_ or enable _Automatically manage signing_.
- Make sure your application's _Deployment Target_ is higher or equal to the [minimum supported version](../../README.md#ios-environment) of the HERE Mobile SDK UI Kit. It should match the iOS version you have set in your podfile (see below).
- Make sure your application's _Deployment Target_ is higher or equal to the [minimum supported version](../../README.md#ios-environment) of the HERE Mobile SDK UI Kit (MSDKUI). It should match the iOS version you have set in your podfile (see below).
- Select a simulator, e.g. iPhone 8, or a real device (recommended).
- We keep default orientation settings.

Now _build and run the current scheme_ and verify that your project executes as expected. If all goes well, you should see blank view without any content.

While all of the functionality of the HERE Mobile SDK UI Kit is accessible from the simulator, usage of a real device is strongly recommended. The overall performance will be better, and some features like gestures are just easier to use on multi-touch-enabled hardware.
While all of the functionality of the HERE Mobile SDK UI Kit (MSDKUI) is accessible from the simulator, usage of a real device is strongly recommended. The overall performance will be better, and some features like gestures are just easier to use on multi-touch-enabled hardware.

### Integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit
### Integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit (MSDKUI)
You can integrate the SDK and the framework manually or via CocoaPods. More details on integrating the HERE Mobile SDK can be found on [developer.here.com](https://developer.here.com/documentation/ios-premium/topics/app-simple-swift.html).

With the full support of the CocoaPods dependency manager, you don't have to download and integrate the HERE Mobile SDK package and the HERE Mobile SDK UI Kit manually. If you are new to CocoaPods or need to install it via Terminal, please follow the steps as described on [guides.cocoapods.org](https://guides.cocoapods.org/using/getting-started.html). Make sure to use the [minimum supported version](../../README.md#ios-environment).
With the full support of the CocoaPods dependency manager, you don't have to download and integrate the HERE Mobile SDK package and the HERE Mobile SDK UI Kit (MSDKUI) manually. If you are new to CocoaPods or need to install it via Terminal, please follow the steps as described on [guides.cocoapods.org](https://guides.cocoapods.org/using/getting-started.html). Make sure to use the [minimum supported version](../../README.md#ios-environment).

To run CocoaPods, please close Xcode and create a new "Podfile" in your project's root folder:
```ruby
Expand All @@ -75,30 +75,30 @@ The podspec for MSDKUI already includes the dependency to the HERE Mobile SDK an

To include the required dependencies, please perform the following steps:

- Open the terminal and navigate to your project folder to execute: `pod install --repo-update`. This will fetch and integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit to your project.
- Open the terminal and navigate to your project folder to execute: `pod install --repo-update`. This will fetch and integrate the HERE Mobile SDK and the HERE Mobile SDK UI Kit (MSDKUI) to your project.
- Once done, please open the newly generated `*.xcworkspace` Xcode project file (do NOT open `*.xcodeproj`).

> If you are getting an error that MSDKUI.modulemap or NMAKit is not found, please make sure to use the latest supported [Cocoapods version](../../README.md#ios-environment). You may need to remove all traces from previous pods by executing `pod deintegrate`. Once done, you can install the pods again.
#### What to do if you have already included the HERE Mobile SDK in an existing project?
If you have already included the HERE Mobile SDK via CocoaPods, then the related dependency (`pod 'HEREMaps’, ‘x.x’`) can be removed from your Podfile. If you used a different SDK version, please make sure that your app is compatible with the [SDK version](../../README.md#supported-platforms) required by the MSDKUI library. If you had the SDK integrated _manually_, please deintegrate it before installing the pods.

#### Can I integrate the HERE Mobile SDK UI Kit manually without CocoaPods?
#### Can I integrate the HERE Mobile SDK UI Kit (MSDKUI) manually without CocoaPods?
Yes, you can. Using CocoaPods is recommended, but if you prefer to build the framework manually, you can integrate the binary similar like adding any other framework to your project.

As a first step, please build the HERE Mobile SDK UI Kit framework. This can be done using a simple `rake` command from your _Terminal_. Please see our [Contribution Guide](ContributionGuide.md) for details.
As a first step, please build the HERE Mobile SDK UI Kit (MSDKUI) framework. This can be done using a simple `rake` command from your _Terminal_. Please see our [Contribution Guide](ContributionGuide.md) for details.

>If you plan to add all dependencies manually, it may be useful to run `pod deintegrate` from the Terminal to clean the project from any pending CocoaPods traces.
1. Copy the resulting `MSDKUI.framework` file to your app's root folder.
2. In Xcode, open the _General_ settings of the _App_ target and add the `MSDKUI.framework` to the _Embedded Binaries_ section ("Add other..." -> "Create folder references")

Make sure the HERE Mobile SDK UI Kit framework also appears below in the section _Linked Frameworks and Libraries_. Same steps apply, when you plan to download and integrate the HERE Mobile SDK fo iOS manually. You can download the HERE Mobile SDK for iOS package from [developer.here.com](http://developer.here.com). Please read this [tutorial](https://developer.here.com/documentation/ios-premium/topics/app-create-simple.html) for more information.
Make sure the HERE Mobile SDK UI Kit (MSDKUI) framework also appears below in the section _Linked Frameworks and Libraries_. Same steps apply, when you plan to download and integrate the HERE Mobile SDK fo iOS manually. You can download the HERE Mobile SDK for iOS package from [developer.here.com](http://developer.here.com). Please read this [tutorial](https://developer.here.com/documentation/ios-premium/topics/app-create-simple.html) for more information.

>If you integrate the MSDKUI library manually into an existing project, please make sure, that your app is compatible with the [HERE Mobile SDK version](../../README.md#supported-platforms) required by the MSDKUI library. If you are using a different SDK version, please update your app to use the required version.
### Set your HERE Mobile SDK credentials
The HERE Mobile SDK (Premium flavor) must be authenticated by providing a set of credentials specific for your project. If you don't know your credentials, please ask your HERE stakeholder or register on [developer.here.com](https://developer.here.com) and create new ones.
The HERE Mobile SDK (Premium Edition) must be authenticated by providing a set of credentials specific for your project. If you don't know your credentials, please ask your HERE stakeholder or register on [developer.here.com](https://developer.here.com) and create new ones.

The HERE Mobile SDK initialization cannot be performed multiple times - only once - and has to be done before the first NMA call. The common place for that would be in the `AppDelegate`'s `application(_ application:didFinishLaunchingWithOptions:)`-callback, but can be done from a different place, if you prefer. For this example, we are setting app id, app code and license key from within the `AppDelegate`, like shown in the code snippet below:

Expand All @@ -112,12 +112,12 @@ NMAApplicationContext.setAppId(appId, appCode: appCode, licenseKey: licenseKey)

>If you want to try out our fully functional demo app or one of the [examples](../Guides_Examples), please, make sure to adapt the bundle identifier to match exactly the one you provided when you requested your credentials on [developer.here.com](https://developer.here.com).
Make sure to add `import NMAKit` and `import MSDKUI` at the top of the file to make sure the HERE Mobile SDK and the HERE Mobile SDK UI Kit are known to your class.
Make sure to add `import NMAKit` and `import MSDKUI` at the top of the file to make sure the HERE Mobile SDK and the HERE Mobile SDK UI Kit (MSDKUI) are known to your class.

Now it is time to test that everything is set up correctly by printing a "Hello" message with the help of the HERE Mobile SDK UI Kit.
Now it is time to test that everything is set up correctly by printing a "Hello" message with the help of the HERE Mobile SDK UI Kit (MSDKUI).

### Add your first HERE Mobile SDK UI Kit component
Once we have the HERE SDK _and_ the HERE Mobile SDK UI Kit available in our project, we open the main view controller Xcode has created for us, i.e. `ViewController.swift`, and add the following imports to include the HERE Mobile SDK and the HERE Mobile SDK UI Kit:
### Add your first HERE Mobile SDK UI Kit (MSDKUI) component
Once we have the HERE SDK _and_ the HERE Mobile SDK UI Kit (MSDKUI) available in our project, we open the main view controller Xcode has created for us, i.e. `ViewController.swift`, and add the following imports to include the HERE Mobile SDK and the HERE Mobile SDK UI Kit (MSDKUI):
```swift
import UIKit
import NMAKit
Expand All @@ -131,9 +131,9 @@ let waypointList = WaypointList(frame: view.bounds)
view.addSubview(waypointList)
```

A `WaypointList` is a HERE Mobile SDK UI Kit component containing items describing waypoints for which a route can be calculated. We initialize the `WaypointList` by giving it the same size as the parent view and then adding it as a subview. Since WaypointList is a child of `UITableView`, it behaves like you would expect from any other `UIView`.
A `WaypointList` is a HERE Mobile SDK UI Kit (MSDKUI) component containing items describing waypoints for which a route can be calculated. We initialize the `WaypointList` by giving it the same size as the parent view and then adding it as a subview. Since WaypointList is a child of `UITableView`, it behaves like you would expect from any other `UIView`.

Usually, you want to initialize HERE Mobile SDK UI Kit components from a storyboard, but all components support both ways. For this Quick Start guide, we only want to see a quick proof how seamless the HERE Mobile SDK UI Kit can be incorporated into your app.
Usually, you want to initialize HERE Mobile SDK UI Kit (MSDKUI) components from a storyboard, but all components support both ways. For this Quick Start guide, we only want to see a quick proof how seamless the HERE Mobile SDK UI Kit (MSDKUI) can be incorporated into your app.

Now it's time to build and run the app. If all goes well, you should see a `WaypointList` with default content covering the whole area of the view.

Expand Down Expand Up @@ -168,7 +168,7 @@ Lastly, we add the following line:
waypointList.itemTextColor = UIColor(red: 1.0, green: 0.77, blue: 0.11, alpha: 1.0)
```

By accessing the `waypointList` properties we can easily make adjustments to this HERE Mobile SDK UI Kit component and customize its look and feel on-the-fly. In this case, we change the default white-on-black text to appear colored.
By accessing the `waypointList` properties we can easily make adjustments to this HERE Mobile SDK UI Kit (MSDKUI) component and customize its look and feel on-the-fly. In this case, we change the default white-on-black text to appear colored.

<center><p>
<img src="./Images/HelloMSDKUI.png" width="250"/>
Expand Down
Loading

0 comments on commit 88ac3ec

Please sign in to comment.