Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme and contribution guidelines #45

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Update readme and contribution guidelines #45

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d39cd32
Update readme and contribution guidelines
nCastle1 Jan 8, 2022
69e4840
Changes from review
nCastle1 Jan 10, 2022
1071e2c
Change from other review
nCastle1 Jan 10, 2022
8835396
Merge branch 'main' into ncastle/readme-sdk-updates
nCastle1 Jan 25, 2022
5e155c3
Update README.md
nCastle1 Jan 28, 2022
ce0592a
Update README.md
nCastle1 Jan 28, 2022
f843b11
Changes from review
nCastle1 Jan 28, 2022
6a29a31
Simplify graphic decoration
nCastle1 Jan 28, 2022
f295b0a
Update README.md
nCastle1 Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
Esri welcomes contributions from anyone and everyone. Please see our
[guidelines for contributing](https://github.com/esri/contributing).
# Contribution guidelines

# Contributing to demos for the ArcGIS Runtime SDK for .NET
Esri welcomes contributions to our open source projects on Github. Please see our [guidelines for contributing](https://github.com/esri/contributing).
nCastle1 marked this conversation as resolved.
Show resolved Hide resolved

## Contribution process

This guide describes how you can contribute improvements to source code.

1. Make sure you have a [GitHub account](https://github.com/signup/free).
2. To add an enhancement or fix a problem, create an issue.
* Be descriptive. Clearly describe the issue including steps to reproduce and, if possible, a sample. If an enhancement, clearly describe the additional functionality and provide a good use case to support it.
2. To add an enhancement or fix a problem, create an issue.
* Be descriptive. Clearly describe the issue including steps to reproduce and, if possible, a sample. If an enhancement, clearly describe the additional functionality and provide a good use case to support it.
3. [Fork](https://help.github.com/articles/fork-a-repo) the [ArcGIS Runtime SDK for .NET Demos repo](https://github.com/Esri/arcgis-runtime-demos-dotnet/) on GitHub.
4. Clone it to your local machine.
5. Checkout the [main branch](https://github.com/Esri/arcgis-runtime-demos-dotnet/tree/main).
6. Create a new feature branch on your local machine. The name of the branch is not important.
6. Create a new feature branch on your local machine. The name of the branch is not important.
7. Write code to add an enhancement or fix a problem.
* Follow the coding conventions already used in the source code.
* Document your code.
Expand All @@ -20,17 +21,21 @@ This guide describes how you can contribute improvements to source code.
8. Test your code.

### Submitting changes

1. Push the changes in your feature branch to your repo.
2. Submit a [pull request](https://help.github.com/articles/using-pull-requests) against the "main" branch.
3. In the pull request comments, add a reference to the issue the pull request resolves. For example, if the pull request resolves issue 45, add a comment to the pull request that includes "#45" (no quotes).
2. Submit a [pull request](https://help.github.com/articles/using-pull-requests) against the "main" branch.
3. In the pull request comments, add a reference to the issue the pull request resolves. For example, if the pull request resolves issue 45, add a comment to the pull request that includes `#45`.

### Code reviews
Expect a good amount of feedback as part of any pull request. Pull requests will be reviewed and tested, and may be rejected for various reasons. If rejected because it would cause a breaking change or includes a feature that is out of scope, it will be closed permanently. If rejected because the proposed changes failed code review or testing, please review feedback, fix and reopen as necessary.

### License
By contributing your code, you agree to license your contribution under the terms of the [Apache License, Version 2.0](license.txt).
Expect a good amount of feedback as part of any pull request.

Your contributions should be an original work of authorship by you, including any modifications or additions to an existing work, that is intentionally submitted for inclusion in this repo. Contributions that require an additional third-party license or have other restrictions (including, but not limited to, related patents and trademarks) will be rejected.
* Pull requests will be reviewed and tested, and may be rejected for various reasons.
* If a PR is rejected because it would cause a breaking change or includes a feature that is out of scope, it will be closed permanently.
* If a PR is rejected because the proposed changes failed code review or testing, please review feedback, fix and reopen as necessary.

### License

By contributing your code, you agree to license your contribution under the terms of the [Apache License 2.0](license.txt) license.

Your contributions should be an original work of authorship by you, including any modifications or additions to an existing work, that is intentionally submitted for inclusion in this repo. Contributions that require an additional third-party license or have other restrictions (including, but not limited to, related patents and trademarks) will be rejected.
74 changes: 47 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,66 @@
ArcGIS Runtime Demos for .NET
===========================
[![Link: ArcGIS Developers Home](https://img.shields.io/badge/ArcGIS%20Developers%20Home-633b9b?style=flat-square)](https://developers.arcgis.com)
[![Link: Documentation](https://img.shields.io/badge/Documentation-633b9b?style=flat-square)](https://developers.arcgis.com/net/)
[![Link: Tutorials](https://img.shields.io/badge/Tutorials-633b9b?style=flat-square)](https://developers.arcgis.com/documentation/mapping-apis-and-services/tutorials/)
[![Link: Samples](https://img.shields.io/badge/Samples-633b9b?style=flat-square)](https://developers.arcgis.com/net/wpf/sample-code/)
![Badge: Demos](https://img.shields.io/badge/Demos-black?style=flat-square)
[![Link: Toolkit](https://img.shields.io/badge/Toolkit-633b9b?style=flat-square)](https://developers.arcgis.com/net/ui-components/)
[![Link: Templates](https://img.shields.io/badge/Templates-633b9b?style=flat-square&logo=visualstudio&labelColor=gray)](https://github.com/Esri/arcgis-runtime-templates-dotnet)
[![Link: NuGet](https://img.shields.io/badge/NuGet-633b9b?style=flat-square&logo=nuget&labelColor=gray)](https://www.nuget.org/profiles/Esri_Inc)
[![Link: Esri Community](https://img.shields.io/badge/🙋-Get%20help%20in%20Esri%20Community-633b9b?style=flat-square)](https://community.esri.com/t5/arcgis-runtime-sdk-for-net/bd-p/arcgis-runtime-sdk-dotnet-questions)
nCastle1 marked this conversation as resolved.
Show resolved Hide resolved
nCastle1 marked this conversation as resolved.
Show resolved Hide resolved

This project contains source code for simple native Windows Desktop, Windows Universal, Xamarin.Android and Xamarin.iOS applications that demonstrate common workflows for utilizing and displaying spatial information with the ArcGIS Runtime SDK for .NET.
You can also find a set of smaller feature-focused samples in the [Runtime Samples](https://github.com/Esri/arcgis-runtime-samples-dotnet) repo.
# ArcGIS Runtime SDK for .NET - Demos

### Demos
**Full applications demonstrate workflows using ArcGIS Runtime**
nCastle1 marked this conversation as resolved.
Show resolved Hide resolved

* [`Symbol Editor`](src/SymbolEditor) - A WPF .NET Core app (and MSIX installer project) that shows using mobile styles, and creating/editing vector symbol layers.
* [`Turn-by-Turn Routing`](src/TurnByTurn) - A universal turn-by-turn app that shows routing and navigation on Windows Desktop, Windows Store and Xamarin.Forms.
* [`Simple Portal Browser`](src/SimplePortalBrowser) - A universal ArcGIS Portal Map Browser app on Windows Phone, Windows Store and Windows Desktop.
* [`Using an External GPS Device`](src/ExternalNmeaGPS) - A Windows Desktop app showing how to use data from an external GPS or NMEA log file to power the MapView's LocationDisplay.
* [`Esri Campus Routing`](src/CampusRouting) - A cross-platform (Xamarin) sample demonstrating indoor geocoding and routing for a campus running on Windows Universal, Android and iOS.
* [`Electronic Navigation Charts (ENC)`](src/HydrographicsSample) - Demonstrates how to work with and render ENC data using the Hydrographics package.
* [`GeoEvent Server Streaming Service`](src/GeoEventServerSample) - Demonstrates how to stream data from ArcGIS GeoEvent Server and render them on the map.
* [`Geocode & Route on MouseMove`](src/GeocodeAndRoutingOnMouseMove) - Demonstrates fast reverse geocoding and routing during mouse-move on Windows Desktop (WPF) and Universal Windows Platform (UWP).
* [`Viewshed analysis in tabletop AR with Xamarin.Forms`](src/ViewshedInTabletopAR) - Demonstrates how to do a viewshed analysis in a tabletop AR scenario using a moving graphic with Xamarin.Forms.
* [`Offline workflows`](src/OfflineWorkflowsSample) - Demonstrates how to browse a portal for offline-enabled maps and take them offline. Also demonstrates how to open maps previously taken offline.
* [`KML Viewer`](src/KmlViewer) - A UWP app for visualizing KML/KMZ files in 2D and 3D.
* [`Editing geometries in a SceneView`](src/SceneViewEdit) - A Windows Desktop app demonstrating how to do geometry editing in 3D using a customer editor.
* [`Measure Tool`](src/MeasureTool) - A simple sample demonstrating how to use the editor to create your own measure tool.
<table align="center" aria-hidden="true">
nCastle1 marked this conversation as resolved.
Show resolved Hide resolved
<tr>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/blob/main/src/ExternalNmeaGPS/Screenshot.jpg?raw=true" title="External NMEA device" height="128" /></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/ViewshedInTabletopAR/ar_demo.jpg" title="Viewshed in tabletop AR" height="128"/></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/GeoEventServerSample/Screenshot_WinDesktop.gif" title="Real-time updates from GeoEvent Server" height="128" /></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/GeocodeAndRoutingOnMouseMove/Screenshot_WinStore.png" height="128" title="Geocode and route as the mouse moves" /></td>

</tr>
<tr>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/HydrographicsSample/Screenshot_WinDesktop.png" title="Display ENC" height="128" /></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/KmlViewer/Screenshot.jpg" title="KML Viewer" height="128" /></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/OfflineWorkflowsSample/pre_planned_screenshot.png" title="Pre-planned offline workflow" height="128" /></td>
<td align="center"><img src="https://github.com/Esri/arcgis-runtime-demos-dotnet/raw/main/src/TurnByTurn/Screenshot.png" title="Turn-by-turn routing" height="128" /></td>
</tr>
<tr></tr>
</table>

## Resources
<hr />

* [ArcGIS Runtime SDK for .NET](https://developers.arcgis.com/net/)
## Contents

## Issues
* [`Symbol Editor`](src/SymbolEditor) - A WPF .NET Core app (and MSIX installer project) shows how to use mobile styles and create/edit vector symbol layers.
* [`Turn-by-Turn Routing`](src/TurnByTurn) - A cross-platform app shows turn-by-turn routing and navigation.
* [`Simple Portal Browser`](src/SimplePortalBrowser) - A cross platform app shows a simple ArcGIS Portal map browser.
* [`Using an External GPS Device`](src/ExternalNmeaGPS) - A Windows Desktop app shows how to use data from an external GPS or NMEA log file to power the MapView's LocationDisplay.
* [`Esri Campus Routing`](src/CampusRouting) - A cross-platform (Xamarin) sample shows indoor geocoding and routing (not using ArcGIS Indoors).
* [`Electronic Navigation Charts (ENC)`](src/HydrographicsSample) - A desktop app shows how to work with and render ENC data using the Hydrographics package.
* [`GeoEvent Server Streaming Service`](src/GeoEventServerSample) - A desktop app shows how to stream data from ArcGIS GeoEvent Server and render that data on a map.
* [`Multi Targeting Project`](src/MultiTargeting) - A single project shows how to use multitargeting to share code with multiple target frameworks supported by ArcGIS Runtime SDK.
* [`Geocode & Route on MouseMove`](src/GeocodeAndRoutingOnMouseMove) - A WPF and UWP app shows fast reverse geocoding and routing as the mouse moves.
* [`Viewshed analysis in tabletop AR with Xamarin.Forms`](src/ViewshedInTabletopAR) - A Xamarin.Forms app shows a viewshed analysis for a moving graphic running in tabletop AR.
* [`Offline workflows`](src/OfflineWorkflowsSample) - A UWP app shows how to browse a portal for offline-enabled maps, take them offline, and open previously downloaded maps.
* [`KML Viewer`](src/KmlViewer) - A UWP app shows how to visualize KML/KMZ files in 2D and 3D.
* [`Editing geometries in a SceneView`](src/SceneViewEdit) - A Windows Desktop app shows how to create a 3D geometry editor.
* [`Measure Tool`](src/MeasureTool) - A UWP app shows how to use Sketch Editor to create a measuring tool.

Find a bug or want to request a new feature? Please let us know by submitting an issue.

## Contributing
## Contribute

Anyone and everyone is welcome to [contribute](CONTRIBUTING.md).

## Licensing
Copyright 2014 Esri
## License

Copyright 2014-2022 Esri

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down