From 09b135d66842e83e0e1848416f555150e99faec0 Mon Sep 17 00:00:00 2001 From: Nathan Castle Date: Tue, 11 Feb 2020 17:45:50 -0800 Subject: [PATCH 1/4] Doc enhancements based on AR feedback --- Documentation/AR/README.md | 4 +++- Documentation/README.md | 17 ++++++++------ README.md | 46 ++++++++++++++++++++++++-------------- 3 files changed, 42 insertions(+), 25 deletions(-) diff --git a/Documentation/AR/README.md b/Documentation/AR/README.md index 0071a5a0..e3d3bc04 100644 --- a/Documentation/AR/README.md +++ b/Documentation/AR/README.md @@ -1,4 +1,6 @@ -# AR +# Augmented reality (AR) + +[![guide doc](https://img.shields.io/badge/Full_Developers_Guide-Doc-purple)](https://developers.arcgis.com/ios/latest/swift/guide/display-scenes-in-augmented-reality.htm) [![world-scale sample](https://img.shields.io/badge/World_Scale-Sample-blue)](https://developers.arcgis.com/ios/latest/swift/sample-code/collect-data-in-ar/) [![Tabletop sample](https://img.shields.io/badge/Tabletop-Sample-blue)](https://developers.arcgis.com/ios/latest/swift/sample-code/display-scenes-in-tabletop-ar/) [![Flyover sample](https://img.shields.io/badge/Flyover-Sample-blue)](https://developers.arcgis.com/ios/latest/swift/sample-code/explore-scenes-in-flyover-ar/) Augmented reality experiences are designed to "augment" the physical world with virtual content that respects real world scale, position, and orientation of a device. In the case of Runtime, a SceneView displays 3D geographic data as virtual content on top of a camera feed which represents the real, physical world. diff --git a/Documentation/README.md b/Documentation/README.md index bbd6a561..f5d1fa4b 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,9 +1,12 @@ ### Table of Contents -* [Compass](Compass) -* [Job Manager](JobManager) -* [Legend View Controller](LegendViewController) -* [Measure Toolbar](MeasureToolbar) -* [Scalebar](Scalebar) -* [TimeSlider](TimeSlider) -* [AR](AR) +* [Augmented reality (AR)](AR/readme) - Integrates the scene view with ARKit to enable augmented reality (AR). +* [Bookmarks](Bookmarks/readme) - Shows bookmarks, from a map, scene, or a list. +* [Compass](Compass/readme) - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. +* [JobManager](JobManager/readme) - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. +* [LegendViewController](LegendViewController/readme) - Displays a legend for a single layer in your map (and optionally for its sub layers). +* [MeasureToolbar](MeasureToolbar/readme) - Allows measurement of distances and areas on the map view. +* [PopupController](PopupController/readme) - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). +* [Scalebar](Scalebar/readme) - Displays current scale reference. +* [TemplatePickerViewController](TemplatePicker/readme) - Allows a user to choose a template from a list of `AGSFeatureTemplate` when creating new features. +* [TimeSlider](TimeSlider/readme) - Allows interactively defining a temporal range (i.e. time extent) and animating time moving forward or backward. Can be used to manipulate the time extent in a MapView or SceneView. diff --git a/README.md b/README.md index 85578222..2728a2ec 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ -# arcgis-runtime-toolkit-ios -Toolkit components that will simplify your iOS app development with ArcGIS Runtime. Check out the [Examples](/Examples) project to see these components in action or read through the [Documentation](/Documentation) to learn more about them. +# ArcGIS Runtime Toolkit for iOS +[![doc](https://img.shields.io/badge/Doc-purple)](Documentation/readme) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![CocoaPods](https://img.shields.io/cocoapods/v/ArcGIS-Runtime-Toolkit-iOS)](https://cocoapods.org/) + +The ArcGIS Runtime SDK for iOS Toolkit contains components that will simplify your iOS app development. Check out the [Examples](/Examples) project to see these components in action or read through the [Documentation](/Documentation) to learn more about them. + +To use Toolkit in your project: + +* **[Install with CocoaPods](#cocoapods)** - Add `pod ArcGIS-Runtime-Toolkit-iOS` to your podfile +* **[Install with Carthage](#carthage)** - Add `github "esri/arcgis-runtime-toolkit-ios"` to your cartfile +* **[Build manually](#manual)** - Build and include manually if you'd like to customize or extend toolkit ## Toolkit Components -* [Compass](Documentation/Compass) -* [JobManager](Documentation/JobManager) -* [LegendViewController](Documentation/LegendViewController) -* [MeasureToolbar](Documentation/MeasureToolbar) -* [Scalebar](Documentation/Scalebar) -* [TimeSlider](Documentation/TimeSlider) -* [PopupController](Documentation/PopupController) -* [TemplatePickerViewController](Documentation/TemplatePicker) -* [AR](Documentation/AR) -* [Bookmarks](Documentation/Bookmarks) +* [Augmented reality (AR)](Documentation/AR) - Integrates the scene view with ARKit to enable augmented reality (AR). +* [Bookmarks](Documentation/Bookmarks) - Shows bookmarks, from a map, scene, or a list. +* [Compass](Documentation/Compass) - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. +* [JobManager](Documentation/JobManager) - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. +* [LegendViewController](Documentation/LegendViewController) - Displays a legend for a single layer in your map (and optionally for its sub layers). +* [MeasureToolbar](Documentation/MeasureToolbar) - Allows measurement of distances and areas on the map view. +* [PopupController](Documentation/PopupController) - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). +* [Scalebar](Documentation/Scalebar) - Displays current scale reference. +* [TemplatePickerViewController](Documentation/TemplatePicker) - Allows a user to choose a template from a list of `AGSFeatureTemplate` when creating new features. +* [TimeSlider](Documentation/TimeSlider) - Allows interactively defining a temporal range (i.e. time extent) and animating time moving forward or backward. Can be used to manipulate the time extent in a MapView or SceneView. ## Requirements + * [ArcGIS Runtime SDK for iOS](https://developers.arcgis.com/en/ios/) 100.7.0 (or higher) * Xcode 10.2 (or higher) @@ -24,6 +33,7 @@ The *ArcGIS Runtime Toolkit for iOS* has a *Target SDK* version of *11.0*, meani ## Instructions ### Cocoapods + 1. Add `pod ArcGIS-Runtime-Toolkit-iOS` to your podfile 2. Run `pod install`. This will download the toolkit and the ArcGIS Runtime SDK for iOS which the toolkit depends upon and then configure your project to reference them both. 3. Add `import ArcGISToolkit` in your source code and start using the toolkit components @@ -32,8 +42,6 @@ The *ArcGIS Runtime Toolkit for iOS* has a *Target SDK* version of *11.0*, meani ### Carthage -[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) - Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. 1. Add `github "esri/arcgis-runtime-toolkit-ios"` to your Cartfile @@ -46,6 +54,7 @@ New to Carthage? Visit the Carthage [GitHub](https://github.com/Carthage/Carthag Note that you must also have the __ArcGIS Runtime SDK for iOS__ installed and your project set up as per the instructions [here](https://developers.arcgis.com/ios/latest/swift/guide/install.htm#ESRI_SECTION1_D57435A2BEBC4D29AFA3A4CAA722506A). ### Manual + 1. Ensure you have downloaded and installed __ArcGIS Runtime SDK for iOS__ as described [here](https://developers.arcgis.com/ios/latest/swift/guide/install.htm#ESRI_SECTION1_D57435A2BEBC4D29AFA3A4CAA722506A) 2. Clone or download this repo. 3. Drag and Drop the `Toolkit/ArcGISToolkit.xcodeproj` file into your project through the XCode Project Navigator pane. @@ -53,23 +62,26 @@ Note that you must also have the __ArcGIS Runtime SDK for iOS__ installed and yo 5. Add `import ArcGISToolkit` in your source code and start using the toolkit components ## SwiftLint + Both the Toolkit and Examples app support SwiftLint. You can install SwiftLint from [here](https://github.com/realm/SwiftLint). It is not necessary to have it installed in order to build, but you will get a warning without it. The specific rules the linter uses can be found in the `swiftlint.yml` files in the `Toolkit` and `Examples` directories. ## Additional Resources -* New to ArcGIS Runtime? Explore the documentation : [Guide](https://developers.arcgis.com/ios) | [API Reference](https://developers.arcgis.com/ios/latest/api-reference/), and check out the [Samples](https://github.com/Esri/arcgis-runtime-samples-ios) +* [Developers guide documentation](https://developers.arcgis.com/ios) +* [Runtime API Reference](https://developers.arcgis.com/ios/latest/api-reference/) +* [Samples](https://github.com/Esri/arcgis-runtime-samples-ios) * Got a question? Ask the community on our [forum](http://geonet.esri.com/community/developers/native-app-developers/arcgis-runtime-sdk-for-ios) ## Issues -Find a bug or want to request a new feature? Please let us know by submitting an issue. +Find a bug or want to request a new feature? Please let us know by [submitting an issue](https://github.com/Esri/arcgis-runtime-toolkit-ios/issues/new). ## Contributing Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing). ## Licensing -Copyright 2017 - 2019 Esri +Copyright 2017 - 2020 Esri Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. From 57da9640532396c40964b108d63c89cf332dd7c4 Mon Sep 17 00:00:00 2001 From: Nathan Castle Date: Tue, 11 Feb 2020 17:52:16 -0800 Subject: [PATCH 2/4] Bold list entries --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2728a2ec..61d3f082 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,16 @@ To use Toolkit in your project: ## Toolkit Components -* [Augmented reality (AR)](Documentation/AR) - Integrates the scene view with ARKit to enable augmented reality (AR). -* [Bookmarks](Documentation/Bookmarks) - Shows bookmarks, from a map, scene, or a list. -* [Compass](Documentation/Compass) - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. -* [JobManager](Documentation/JobManager) - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. -* [LegendViewController](Documentation/LegendViewController) - Displays a legend for a single layer in your map (and optionally for its sub layers). -* [MeasureToolbar](Documentation/MeasureToolbar) - Allows measurement of distances and areas on the map view. -* [PopupController](Documentation/PopupController) - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). -* [Scalebar](Documentation/Scalebar) - Displays current scale reference. -* [TemplatePickerViewController](Documentation/TemplatePicker) - Allows a user to choose a template from a list of `AGSFeatureTemplate` when creating new features. -* [TimeSlider](Documentation/TimeSlider) - Allows interactively defining a temporal range (i.e. time extent) and animating time moving forward or backward. Can be used to manipulate the time extent in a MapView or SceneView. +* **[Augmented reality (AR)](Documentation/AR)** - Integrates the scene view with ARKit to enable augmented reality (AR). +* **[Bookmarks](Documentation/Bookmarks)** - Shows bookmarks, from a map, scene, or a list. +* **[Compass](Documentation/Compass)** - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. +* **[JobManager](Documentation/JobManager)** - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. +* **[LegendViewController](Documentation/LegendViewController)** - Displays a legend for a single layer in your map (and optionally for its sub layers). +* **[MeasureToolbar](Documentation/MeasureToolbar)** - Allows measurement of distances and areas on the map view. +* **[PopupController](Documentation/PopupController)** - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). +* **[Scalebar](Documentation/Scalebar)** - Displays current scale reference. +* **[TemplatePickerViewController](Documentation/TemplatePicker)** - Allows a user to choose a template from a list of `AGSFeatureTemplate` when creating new features. +* **[TimeSlider](Documentation/TimeSlider)** - Allows interactively defining a temporal range (i.e. time extent) and animating time moving forward or backward. Can be used to manipulate the time extent in a MapView or SceneView. ## Requirements From f63c4097a484c30f478e28ae26552d04439de011 Mon Sep 17 00:00:00 2001 From: Nathan Castle Date: Wed, 12 Feb 2020 12:41:07 -0800 Subject: [PATCH 3/4] Update README.md Co-Authored-By: Mark Dostal --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 61d3f082..6d9b4113 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ To use Toolkit in your project: * **[Bookmarks](Documentation/Bookmarks)** - Shows bookmarks, from a map, scene, or a list. * **[Compass](Documentation/Compass)** - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. * **[JobManager](Documentation/JobManager)** - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. -* **[LegendViewController](Documentation/LegendViewController)** - Displays a legend for a single layer in your map (and optionally for its sub layers). +* **[LegendViewController](Documentation/LegendViewController)** - Displays a legend for all the layers in a map or scene contained in an `AGSGeoView`. * **[MeasureToolbar](Documentation/MeasureToolbar)** - Allows measurement of distances and areas on the map view. * **[PopupController](Documentation/PopupController)** - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). * **[Scalebar](Documentation/Scalebar)** - Displays current scale reference. @@ -96,4 +96,3 @@ See the License for the specific language governing permissions and limitations under the License. A copy of the license is available in the repository's [LICENSE]( /LICENSE) file. - From 98c90d091511f92d135c600f6511c622a38dc09f Mon Sep 17 00:00:00 2001 From: Nathan Castle Date: Wed, 12 Feb 2020 12:41:18 -0800 Subject: [PATCH 4/4] Update Documentation/README.md Co-Authored-By: Mark Dostal --- Documentation/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/README.md b/Documentation/README.md index f5d1fa4b..27df7223 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -4,7 +4,7 @@ * [Bookmarks](Bookmarks/readme) - Shows bookmarks, from a map, scene, or a list. * [Compass](Compass/readme) - Shows a compass direction when the map is rotated. Auto-hides when the map points north up. * [JobManager](JobManager/readme) - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched. -* [LegendViewController](LegendViewController/readme) - Displays a legend for a single layer in your map (and optionally for its sub layers). +* [LegendViewController](LegendViewController/readme) - Displays a legend for all the layers in a map or scene contained in an `AGSGeoView`. * [MeasureToolbar](MeasureToolbar/readme) - Allows measurement of distances and areas on the map view. * [PopupController](PopupController/readme) - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics). * [Scalebar](Scalebar/readme) - Displays current scale reference.