From ca34315ebcc235bb6afefc2c667359984157f154 Mon Sep 17 00:00:00 2001 From: Danila Kovalev Date: Fri, 26 Feb 2021 18:24:11 +0700 Subject: [PATCH 1/5] SDK docs skeleton introduced. --- docs/ru/examples.md | 18 +++++++++++++++++- docs/ru/overview.md | 31 +++++++++++++++++++++---------- 2 files changed, 38 insertions(+), 11 deletions(-) diff --git a/docs/ru/examples.md b/docs/ru/examples.md index 1e349ed..8705c5d 100644 --- a/docs/ru/examples.md +++ b/docs/ru/examples.md @@ -1,5 +1,21 @@ -## Инициализации +## Начало работы +Для запуска примера: +1. Склонируйте [GitHub-репозиторий 2GIS](https://github.com/2gis/native-sdk-ios-demo). +2. Откройте проект `app.xcodeproj` и задайте ваши ключи API в файле `Info.plist` проекта: + + ``` + dgisMapApiKey=YOUR_MAP_KEY + dgisDirectoryApiKey=YOUR_DIRECTIONS_KEY + ``` + +3. Дождитесь загрузки зависимостей Swift. Эта операция может занять длительное время. + + Вы не сможете собрать и запустить проект, пока не будут загружены зависимости. + +4. Соберите и запустите проект (⌘+R). + +## Инициализация *// TODO: инициализация SDK, работа с ключами* ## Общая информация diff --git a/docs/ru/overview.md b/docs/ru/overview.md index 70f455a..1a02ad9 100644 --- a/docs/ru/overview.md +++ b/docs/ru/overview.md @@ -1,16 +1,27 @@ -# Overview +# 2GIS iOS Native SDK -## Introduction -2GIS iOS NativeSDK is an SDK that allows you to add a 2GIS map to your iOS application. It can be used to display the map in your layout, add custom markers to it, and highlight various objects on the map, such as buildings, roads, and others. +iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](https://2gis.ru/) в ваше приложение под iOS. С его помощью вы можете отображать карту на экране, добавлять на карту пользовательские маркеры, а также выделять на карте различные объекты, такие как здания, дороги и т. д. -## Getting an access key -Usage of this SDK requires an API key to connect to 2GIS servers and retrieve the geographical data. This API key is unique to the SDK and cannot be used with other 2GIS SDKs. +> :warning: **2GIS iOS Native SDK в процессе разработки.** Не подготовлено к использованию в боевых приложениях. -To obtain the key, [contact us](https://dev.2gis.ru/order/). +## Получение ключа доступа -## Installation -*// TBD* +Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS. -### Минимальные требования: +Кроме того, если вы планируете прокладывать маршруты на карте, то для вычисления и отображения оптимального маршрута вам понадобится отдельный ключ API - для [Directions API](/ru/api/navigation/directions/overview). + +Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order). + +## Установка + +... + +Минимальные требования: - XCode 12; -- Чтобы запустить демо-проект через XCode, необходимо использовать любой симулятор или устройство с iOS (iPadOS) 13.0+. Это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui). +- Симулятор или устройство с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)). + +При необходимости можно использовать [xcframework](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12. + +После этого всё должно быть готово к работе. В разделе [Примеры](/ru/ios/native/maps/examples) вы можете посмотреть, как добавить карту к вашему приложению. Или загляните в [описание API](/en/ios/native/maps/reference/Container), чтобы узнать больше о конкретных классах и методах. + +Также доступен [GitHub-репозиторий](https://github.com/2gis/native-sdk-ios-demo/), в котором можно познакомиться с SDK и демонстрационным проектом. From fef3d7bbcbefb3c805100750af637475dcb8221c Mon Sep 17 00:00:00 2001 From: Danila Kovalev Date: Fri, 26 Feb 2021 18:35:24 +0700 Subject: [PATCH 2/5] SDK docs README skeleton introduced. --- README.md | 58 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f4cedb8..7c3a2e6 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,47 @@ -# 2GIS iOS NativeSDK Demo +# 2GIS iOS Native SDK -> ⚠️ 2GIS NativeSDK в процессе разработки. Не подготовлено к использованию в боевых приложениях. +iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](https://2gis.ru/) в ваше приложение под iOS. С его помощью вы можете отображать карту на экране, добавлять на карту пользовательские маркеры, а также выделять на карте различные объекты, такие как здания, дороги и т. д. -2GIS NativeSDK iOS Demo - это проект, демонстрирующий разработчику возможности использования нативного инструмента работы с картой от команды 2ГИС под iOS. +> :warning: **2GIS iOS Native SDK в процессе разработки.** Не подготовлено к использованию в боевых приложениях. -### Документация: -Демо-проект не охватывает всех возможностей NativeSDK. Для более детального анализа и проработки необходимо обратиться к [официальной документации](https://docs-canary.2gis.com/ru/ios/native/maps/reference/Container). +## Получение ключа доступа -### Минимальные требования: +Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS. + +Кроме того, если вы планируете прокладывать маршруты на карте, то для вычисления и отображения оптимального маршрута вам понадобится отдельный ключ API - для [Directions API](/ru/api/navigation/directions/overview). + +Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order). + +## Установка + +... + +Минимальные требования: - XCode 12; -- Для того чтобы запусить проект через XCode достаточно использовать любой симулятор или девайс с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)). +- Симулятор или устройство с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)). + +При необходимости можно использовать [xcframework](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12. + +## Запуск демо-приложения + +Чтобы запустить демонстрационное приложение: +1. Склонируйте этот репозиторий. +2. Откройте проект `app.xcodeproj` и задайте ваши ключи API в файле `Info.plist` проекта: + + ``` + dgisMapApiKey=YOUR_MAP_KEY + dgisDirectoryApiKey=YOUR_DIRECTIONS_KEY + ``` + +3. Дождитесь загрузки зависимостей Swift. Эта операция может занять длительное время. -> **При необходимости можно использовать xcframework, расположенный по [ссылке](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12**. + Вы не сможете собрать и запустить проект, пока не будут загружены зависимости. + +4. Соберите и запустите проект (⌘+R). -### Установка: -1. Склонировать проект любым удобным способом - - через Терминал, используя команду -```bash -git clone https://github.com/2gis/native-sdk-ios-demo.git -``` - - через SourceTree File -> New -> Clone with URL - - любым другим удобным способом -2. Запустить проект `app.xcodeprojxx в рутовой директории проекта. -3. Выставить ключи `DGISDirectoryAPIKey` и `DGISMapAPIKey` в файле `Info.plist`. -> Для получения ключей [напишите нам](https://dev.2gis.ru/order/). +## Документация -4. Дождаться подгрузки свифтовых зависимостей (необходимо иметь устойчивое интернет-соединение, т.к. zip-архив с xcframework весит 200+ МБ). -5. Cmd + R +Полная документация по SDK, включающая [примеры использования](https://docs.2gis.com/ru/ios/native/maps/examples) и [справочник API](https://docs.2gis.com/en/ios/native/maps/reference/Container) с детальным описанием всех классов и методов, расположена на [docs.2gis.com](https://docs.2gis.com/ru/ios/native/maps/overview). -> ⚠️ В случае если зависимости не подгрузились, вы увидите уведомление **Build operations are disabled: Package loading in progress**. В таком случае нужно дождаться выполнения предыдущего пункта. From 49119d610676270b86838a66a13d8375cdbfc16a Mon Sep 17 00:00:00 2001 From: Sergey Lagner Date: Sun, 21 Mar 2021 16:34:00 +0700 Subject: [PATCH 3/5] API keys description in README has been corrected --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c3a2e6..48fa91b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](h Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS. -Кроме того, если вы планируете прокладывать маршруты на карте, то для вычисления и отображения оптимального маршрута вам понадобится отдельный ключ API - для [Directions API](/ru/api/navigation/directions/overview). +Кроме того, если вы планируете использовать справочник или прокладывать маршруты на карте, то вам понадобится отдельный ключ API. Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order). From 17760f8d9d2ec80927e60dc64524e29faeb00de7 Mon Sep 17 00:00:00 2001 From: Sergey Lagner Date: Sun, 21 Mar 2021 16:39:58 +0700 Subject: [PATCH 4/5] API keys description in Overview has been corrected --- docs/ru/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ru/overview.md b/docs/ru/overview.md index 1a02ad9..387e65a 100644 --- a/docs/ru/overview.md +++ b/docs/ru/overview.md @@ -8,7 +8,7 @@ iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](h Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS. -Кроме того, если вы планируете прокладывать маршруты на карте, то для вычисления и отображения оптимального маршрута вам понадобится отдельный ключ API - для [Directions API](/ru/api/navigation/directions/overview). +Кроме того, если вы планируете использовать справочник или прокладывать маршруты на карте, то вам понадобится отдельный ключ API. Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order). From fb129b1310866e3f221692154a441ef30c3678b4 Mon Sep 17 00:00:00 2001 From: Sergey Lagner Date: Sun, 21 Mar 2021 16:58:04 +0700 Subject: [PATCH 5/5] define example programming language --- docs/ru/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ru/examples.md b/docs/ru/examples.md index 8705c5d..5a4e09c 100644 --- a/docs/ru/examples.md +++ b/docs/ru/examples.md @@ -166,7 +166,7 @@ let polyline = objectsManager.addPolyline(options: options) потому что уничтожение `Cancellable`-объекта приводит к немедленной отмене подписки на `Future`. -``` +```swift /// - Parameter point: A tap point in *pixel* (native scale) cooordinates. /// - Parameter tapRadius: Radius around tap point in which objects will /// be detected.