Azure-Samples / digital-twins-samples-csharp

Samples of how to interact with Azure Digital Twins service.
MIT License
41 stars 46 forks source link

Occupancy Sample could use a few clarifications #30

Closed ghost closed 6 years ago

ghost commented 6 years ago

Description

I'm on the following page: https://github.com/Azure-Samples/digital-twins-samples-csharp/blob/master/occupancy-quickstart/readme.md

The "Update appsettings.json using a text editor" should refer to it as appSettings.json to be consistent on casing. The following commands have a couple of issue:

Run the app (and see usage) dotnet restore cd src dotnet run

dotnet restore has to be run from within src, so the first two lines should be reversed in order. Also, the "dotnet run" doesn't actually run the app as would be implied by "Run the app", it just shows the usage.

Additionally, it would be helpful for the initial part of this sample to be linking to the tutorial that lets you create the Digital Twins instance.

fernandoviton commented 6 years ago

Thanks! AppSettings: Based on this feedback and others' I added a section to the readme with more details on appsettings as well as moved the link to quickstart docs at the top of the getting started steps (instead of below).

Also fixed dotnet restore to be after cd src.

Also called out the quickstart again and made it clearer this will show usage.

(These changes are currently in a branch but I will open a PR soon)