Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 5.91 KB

README.md

File metadata and controls

98 lines (65 loc) · 5.91 KB
Raw

HERE Data SDK for C++

HERE Data SDK for C++ is a C++ client for the HERE platform.

Use the SDK

To learn how to install and use the Data SDK, see the Getting Started Guide and Developer Guide.

Health check

Build and test

Linux GCC Linux CLang MacOS
Linux gcc build status Linux Clang build status MacOS build status
iOS Windows Android
iOS build status Windows build status Android build status

Test coverage

Platform Status
Linux Linux code coverage

Backward compatibility

We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for C++ every half a year.

For more information on Data API, see its Developer Guide and API Reference.

When new API is introduced in Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.

Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ API Reference and changelog.

For more information on Data SDK for C++, see our Developer Guide.

Supported platforms

The table below lists the platforms on which the Data SDK has been tested.

Platform Minimum requirement
Ubuntu Linux GCC 7.5 and Clang 7.0
Embedded Linux (32 bit) GCC 7.4 armhf
Windows MSVC++ 2017
macOS Apple Clang 11.0.0
iOS Xcode 11.1, Swift 5.0
Android API level 21

Dependencies

The table below lists the dependencies of the Data SDK.

Library Recommended version
libcurl 7.52.0
OpenSSL 1.1.1g
Boost (headers only) 1.69.0
LevelDB 1.21
Snappy 1.1.7
RapidJSON latest

Linux dependencies

To install the dependencies on Linux, run the following command:

sudo apt-get update && sudo apt-get --yes install git g++ make cmake libssl-dev libcurl4-openssl-dev libboost-all-dev

Note

Please note that on some Linux distribution, the default libcurl version can be lower than the required v7.52.0. In that case, you need to install the required libcurl version from a different PPA.

Contribution

For details, see HERE Data SDK C++ Contributors Guide.

LICENSE

Copyright (C) 2019–2023 HERE Europe B.V.

For license details, see the LICENSE file in the root of this project.

Note

This project has Open Source Software dependencies that are downloaded and installed upon execution of the abovementioned installation commands. For further details, see the CMake configuration files included in the external directory.