Skip to content

Commit 4b17546

Browse files
EllerbachEllerbach
authored
Improving README (#338)
1 parent 9ae113f commit 4b17546

File tree

94 files changed

+374
-82
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+374
-82
lines changed

‎samples/1-Wire/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ The next steps depend on whether you just want to deploy the sample or you want
5151

5252
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
5353

54+
> [!NOTE]
55+
>
5456
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
55-
57+
>
5658
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/ADC/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Any hardware device running a nanoFramework image.
1616

1717
## Build the sample
1818

19-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
19+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2020
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2121
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2222

@@ -32,5 +32,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3232

3333
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3434

35+
> [!NOTE]
36+
>
3537
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
38+
>
3639
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AMQP/Azure-IoT-Hub/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ After setting up the access to you IoT Hub, navigate to the device, enter the de
2727

2828
## Build the sample
2929

30-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
30+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
3131
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
3232
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
3333

@@ -43,5 +43,8 @@ The next steps depend on whether you just want to deploy the sample or you want
4343

4444
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4545

46+
> [!NOTE]
47+
>
4648
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
49+
>
4750
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AMQP/Azure-ServiceBus-Sender/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ After setting up the access to you IoT Hub, navigate to the device, enter the de
2727

2828
## Build the sample
2929

30-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
30+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
3131
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
3232
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
3333

@@ -43,5 +43,8 @@ The next steps depend on whether you just want to deploy the sample or you want
4343

4444
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4545

46+
>> [!NOTE]
47+
>
4648
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
49+
>
4750
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AMQP/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ After setting up the access to you IoT Hub, navigate to the device, enter the de
2727

2828
## Build the sample
2929

30-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
30+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
3131
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
3232
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
3333

@@ -43,5 +43,8 @@ The next steps depend on whether you just want to deploy the sample or you want
4343

4444
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4545

46+
> [!NOTE]
47+
>
4648
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
49+
>
4750
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AzureMQTTTwinsBMP280Sleep/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ This code has been tested with ESP32 boards. Note that there is a specific secti
1111

1212
The sample uses wifi, this part can be as well replaced with an ethernet connection. It will work the exact same way.
1313

14-
> **Important**: In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
14+
> [!Important]
15+
>
16+
> In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
1517
1618
### Reference
1719

@@ -23,7 +25,7 @@ The sample uses wifi, this part can be as well replaced with an ethernet connect
2325
## Build the sample
2426

2527
1. Simply adjust the device IoT Hub elements and your network.
26-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
28+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2729
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2830
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2931

@@ -41,5 +43,8 @@ The next steps depend on whether you just want to deploy the sample or you want
4143

4244
**Important**: You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
4345

46+
> [!NOTE]
47+
>
4448
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
49+
>
4550
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AzureSDK/AzureSDKBasic/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ This code has been tested with ESP32 boards. This can be replaced by any other b
1717

1818
The sample uses wifi, this part can be as well replaced with an ethernet connection. It will work the exact same way.
1919

20-
> **Important**: In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
20+
> [!Important]
21+
>
22+
> In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
2123
2224
### Reference
2325

@@ -34,4 +36,10 @@ The sample uses wifi, this part can be as well replaced with an ethernet connect
3436

3537
## Run the sample
3638

37-
**Important**: You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
39+
> [!Important]
40+
>
41+
> You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
42+
>
43+
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
44+
>
45+
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AzureSDK/AzureSDKSleepBMP280/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ This code has been tested with ESP32 boards. This can be replaced by any other b
1111

1212
The sample uses wifi, this part can be as well replaced with an ethernet connection. It will work the exact same way.
1313

14-
> **Important**: In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
14+
> [!Important]
15+
>
16+
> In this sample, if the connection or something is not setup properly you won't be able to debug properly. Please make sure you are using another sample to understand how Azure Client with a sample and deep sleep is working before using this one.
1517
1618
### Reference
1719

@@ -29,4 +31,10 @@ The sample uses wifi, this part can be as well replaced with an ethernet connect
2931

3032
## Run the sample
3133

32-
**Important**: You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
34+
> [!Important]
35+
>
36+
> You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
37+
>
38+
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
39+
>
40+
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/AzureSDK/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ These samples are using [Azure IoT Hub SDK](https://github.com/nanoframework/nan
1111

1212
## Build the sample
1313

14-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
14+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
1515
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
1616
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
1717

@@ -27,5 +27,8 @@ The next steps depend on whether you just want to deploy the sample or you want
2727

2828
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
2929

30+
> [!NOTE]
31+
>
3032
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
33+
>
3134
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/Blinky/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Some boards like most of the ESP32 dev kits and most of the STM32 boards have an
1818

1919
## Build the sample
2020

21-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
21+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2222
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2323
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2424

@@ -34,5 +34,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3434

3535
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3636

37+
> [!NOTE]
38+
>
3739
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
40+
>
3841
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/Bluetooth/BluetoothLESerial/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Currently there are 2 firmware images that support Bluetooth:-
3030

3131
## Build the sample
3232

33-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
33+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
3434
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
3535
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
3636

@@ -46,5 +46,8 @@ The next steps depend on whether you just want to deploy the sample or you want
4646

4747
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4848

49+
> [!NOTE]
50+
>
4951
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
52+
>
5053
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/Bluetooth/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,8 @@ The next steps depend on whether you just want to deploy the sample or you want
9494

9595
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
9696

97+
> [!NOTE]
98+
>
9799
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
100+
>
98101
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/CAN/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The code sample is demonstrative of the use of the CAN API.
2020

2121
## Build the sample
2222

23-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
23+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2424
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2525
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2626

@@ -36,5 +36,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3636

3737
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3838

39+
> [!NOTE]
40+
>
3941
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
42+
>
4043
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/Collections/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This sample is coded to use the STM32F769IDiscovery target board, but can be eas
1717

1818
## Build the sample
1919

20-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
20+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2121
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2222
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2323

@@ -33,5 +33,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3333

3434
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3535

36+
> [!NOTE]
37+
>
3638
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
39+
>
3740
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/Converter.Base64/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Any hardware device running a nanoFramework image.
1717

1818
## Build the sample
1919

20-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
20+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2121
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2222
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2323

@@ -33,5 +33,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3333

3434
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3535

36+
> [!NOTE]
37+
>
3638
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
39+
>
3740
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/DAC/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Any hardware device running a nanoFramework image built with DAC support enabled
5252

5353
## Build the sample
5454

55-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
55+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
5656
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
5757
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
5858

@@ -68,5 +68,8 @@ The next steps depend on whether you just want to deploy the sample or you want
6868

6969
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
7070

71+
> [!NOTE]
72+
>
7173
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
74+
>
7275
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/DebugGC.Test/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Any hardware device running a nanoFramework image.
2222

2323
## Build the sample
2424

25-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
25+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2626
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2727
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2828

@@ -38,5 +38,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3838

3939
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4040

41+
> [!NOTE]
42+
>
4143
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
44+
>
4245
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/DependencyInjection/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3131

3232
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3333

34+
> [!NOTE]
35+
>
3436
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
37+
>
3538
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

‎samples/ExecutionConstraint/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Any hardware device running a nanoFramework image.
1818

1919
## Build the sample
2020

21-
1. Start Microsoft Visual Studio 2019 (VS 2017 should be OK too) and select `File > Open > Project/Solution`.
21+
1. Start Microsoft Visual Studio 2022 or Visual Studio 2019 (Visual Studio 2017 should be OK too) and select `File > Open > Project/Solution`.
2222
1. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
2323
1. Press `Ctrl+Shift+B`, or select `Build > Build Solution`.
2424

@@ -34,5 +34,8 @@ The next steps depend on whether you just want to deploy the sample or you want
3434

3535
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3636

37+
> [!NOTE]
38+
>
3739
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
40+
>
3841
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

0 commit comments

Comments
 (0)