diff --git a/samples/1-Wire/README.md b/samples/1-Wire/README.md index 1ef7c1268..968f7ad1f 100644 --- a/samples/1-Wire/README.md +++ b/samples/1-Wire/README.md @@ -28,7 +28,7 @@ If you have another type of device supporting 1-Wire, you will have to adjust th ### Reference -- [nanoFramework.Devices.OneWire](http://docs.nanoframework.net/api/nanoFramework.Devices.OneWire.html) +- [nanoFramework.Device.OneWire](http://docs.nanoframework.net/api/nanoFramework.Device.OneWire.html) - [1-Wire Protocol](https://en.wikipedia.org/wiki/1-Wire) ## Build the sample diff --git a/samples/AzureMQTTTwinsBMP280Sleep/README.md b/samples/AzureMQTTTwinsBMP280Sleep/README.md index d120f1d22..be91cc7e2 100644 --- a/samples/AzureMQTTTwinsBMP280Sleep/README.md +++ b/samples/AzureMQTTTwinsBMP280Sleep/README.md @@ -16,7 +16,7 @@ The sample uses wifi, this part can be as well replaced with an ethernet connect - [nanoFramework.IoT.Device Bmxx80 devices](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Bmxx80). - [Azure IoT documentation for MQTT](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-mqtt-support). - [nanoFramework Network helpers](https://github.com/nanoframework/System.Device.Wifi). -- [More elements about Azure MQTT connection for nanoFramework](../MQTT/AzureMQTT). +- [More elements about Azure MQTT connection for nanoFramework](../MQTT/AdvancedExample.Azure). ## Build the sample diff --git a/samples/AzureSDK/AzureEdgeOta/README.md b/samples/AzureSDK/AzureEdgeOta/README.md index d5b0c3e34..b85c59768 100644 --- a/samples/AzureSDK/AzureEdgeOta/README.md +++ b/samples/AzureSDK/AzureEdgeOta/README.md @@ -87,7 +87,7 @@ Twin for the device: - [nanoFramework.IoT.Device Bmxx80 devices](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Bmxx80). - [Azure IoT documentation for MQTT](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-mqtt-support). -- [nanoFramework Network helpers](https://github.com/nanoframework/Windows.Devices.Wifi) +- [nanoFramework Network helpers](https://github.com/nanoframework/System.Device.Wifi) ## Build the sample diff --git a/samples/Collections/README.md b/samples/Collections/README.md index d2f0f3db8..0f9a97c63 100644 --- a/samples/Collections/README.md +++ b/samples/Collections/README.md @@ -1,6 +1,6 @@ # 🌶️ - Collections sample -Shows how to use the [System.Collections.Hastable](http://docs.nanoframework.net/api/nanoFramework.System.Collection.Hashtable.html). +Shows how to use the [System.Collections.Hashtable](http://docs.nanoframework.net/api/System.Collections.Hashtable.html). ## Hardware requirements @@ -11,7 +11,7 @@ This sample is coded to use the STM32F769IDiscovery target board, but can be eas ### Reference -- [System.Collections.Hastable](http://docs.nanoframework.net/api/nanoFramework.System.Collection.Hashtable.html). +- [System.Collections.Hashtable](http://docs.nanoframework.net/api/System.Collections.Hashtable.html). ## Build the sample diff --git a/samples/Gpio/Gpio+Events/README.md b/samples/Gpio/Gpio+Events/README.md index 1bf4996dd..8dc088528 100644 --- a/samples/Gpio/Gpio+Events/README.md +++ b/samples/Gpio/Gpio+Events/README.md @@ -1,8 +1,8 @@ # 🌶️ - GPIO and events sample -Shows how to use the [Windows.Devices.Gpio](http://docs.nanoframework.net/api/Windows.Devices.Gpio.html) API allowing your to set and read the state of GPIO pins. +Shows how to use the [System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html) API allowing you to set and read the state of GPIO pins. -Shows how to use the [Windows.Devices.Gpio]() API allowing your to: +Shows how to use the [System.Device.Gpio]() API allowing your to: - set the state of output GPIO pins - read state of input GPIO pins @@ -20,7 +20,7 @@ Any hardware device running a nanoFramework image built with GPIO support enable ### Reference -[Windows.Devices.Gpio](http://docs.nanoframework.net/api/Windows.Devices.Gpio.html) +[System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html) ## System requirements diff --git a/samples/Gpio/README.md b/samples/Gpio/README.md index c92008354..224d71d27 100644 --- a/samples/Gpio/README.md +++ b/samples/Gpio/README.md @@ -1,11 +1,11 @@ # 🌶️ - GPIO sample pack -Shows how to use the GPIO related APIs in [Windows.Devices.Gpio](http://docs.nanoframework.net/api/Windows.Devices.Gpio.html) and [System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html). +Shows how to use the GPIO related APIs in [System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html) and [System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html). ## Samples -- [🌶️ - GPIO + Events](Gpio2%BEvents/) -- [🌶️ - Gpio + Events (IoT Style)](Gpio2%BEventsIoTStyle/) +- [🌶️ - GPIO + Events](Gpio%2BEvents/) +- [🌶️ - Gpio + Events (IoT Style)](Gpio%2BEventsIoTStyle/) - [🌶️ - ESP32 Pulse Count samples](Esp32PulseCounter) ## Build the sample diff --git a/samples/Graphics/README.md b/samples/Graphics/README.md index bbcb05e0d..58ad1369d 100644 --- a/samples/Graphics/README.md +++ b/samples/Graphics/README.md @@ -9,7 +9,7 @@ Current targets are for the samples are ESP32 and the STM32F769I_DISCOVERY. But > **CRITICAL**: all display **must** be initialized before being able to be used. -This initialization can be different depending on your device. ESP32 devices must be properly initialize to work, the GPIO must match the functions. You also need to know the exact size of the screen. See the [M5Stack](../Screens/README.md) and M5Stick examples for more configurations. +This initialization can be different depending on your device. ESP32 devices must be properly initialize to work, the GPIO must match the functions. You also need to know the exact size of the screen. See the [M5Stack](../Graphics/Screens/README.md) and M5Stick examples for more configurations. ```csharp int backLightPin = 32; diff --git a/samples/HTTP/README.md b/samples/HTTP/README.md index a6600f49b..cdf6b3c43 100644 --- a/samples/HTTP/README.md +++ b/samples/HTTP/README.md @@ -20,13 +20,13 @@ Please note that samples are offered in "pairs": one for wired connected targets ### HTTP Azure Get -Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform GET requests](./AzureGET). -Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform GET requests with wifi](./AzureGET_Wifi) for Wi-Fi connected targets. +Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform GET requests](./HttpAzureGET). +Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform GET requests with wifi](./HttpAzureGET_Wifi) for Wi-Fi connected targets. ### HTTP Azure POST -Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform POST requests](./AzurePOST). -Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform POST requests with wifi](./AzurePOST) for Wi-Fi connected targets. +Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform POST requests](./HttpAzurePOST). +Illustrates how to connect to [🌶️🌶️🌶️ - Azure and perform POST requests with wifi](./HttpAzurePOST) for Wi-Fi connected targets. ## Hardware requirements diff --git a/samples/Hardware.Esp32.Rmt/README.md b/samples/Hardware.Esp32.Rmt/README.md index fbfeb70aa..773e846a0 100644 --- a/samples/Hardware.Esp32.Rmt/README.md +++ b/samples/Hardware.Esp32.Rmt/README.md @@ -11,7 +11,7 @@ Samples - [🌶️🌶️ - NeoPixel Strip WS2812](NeoPixelStrip/) - [🌶️🌶️ - NeoPixel Strip WS2812 with low memory consumption](NeoPixelStripLowMemory/) -> **Note**: those sensors and devices are available as nuget in [Device.IoT repository](https://github.com/nanoFramework/nanoFramework.Deive.IoT). +> **Note**: those sensors and devices are available as nuget in [Device.IoT repository](https://github.com/nanoFramework/nanoFramework.IoT.Device). ## Hardware requirements diff --git a/samples/Hardware.TI/README.md b/samples/Hardware.TI/README.md index 93a0f52f5..b9f1b68ad 100644 --- a/samples/Hardware.TI/README.md +++ b/samples/Hardware.TI/README.md @@ -2,8 +2,8 @@ Shows how to use various APIs specific to TI SimpleLink targets. -- [Power down/off test](/TI.PowerMode) -- [Read IEEE Address](/TI.Utilities) +- [Power down/off test](/samples/Hardware.TI/TI.PowerMode) +- [Read IEEE Address](/samples/Hardware.TI/TI.Utilities) ## Hardware requirements diff --git a/samples/Json/README.md b/samples/Json/README.md index 93704397b..b3d0512fb 100644 --- a/samples/Json/README.md +++ b/samples/Json/README.md @@ -1,6 +1,6 @@ # 🌶️🌶️ - nanoFramework Json sample -Please [see](https://github.com/nanoframework/nanoFramework.Json/tree/develop/nanoFramework.Json.Test) for more sample usage. +Please [see](https://github.com/nanoframework/nanoFramework.Json/tree/main/nanoFramework.Json.Test) for more sample usage. Shows how to use the nanoFramework Json library to store and retrieve configuration from storage. diff --git a/samples/Logging/README.md b/samples/Logging/README.md index 81549cc08..06f78bae7 100644 --- a/samples/Logging/README.md +++ b/samples/Logging/README.md @@ -2,7 +2,7 @@ You will find a short sample in [this project](./Program.cs). -More examples and how to use it in the [main nanoFramework.Logging documentation](https://github.com/nanoframework/nanoFramework.Logging/blob/develop/README.md). +More examples and how to use it in the [main nanoFramework.Logging documentation](https://github.com/nanoframework/nanoFramework.Logging/blob/main/README.md). ## Hardware requirements @@ -12,7 +12,7 @@ Any hardware device running a nanoFramework image. ### Reference -Check as well the [Tests from the nanoFramework.Logging](https://github.com/nanoframework/nanoFramework.Logging/tree/develop/Tests/UnitTestDebugLogging), they gives as well advance scenarios. +Check as well the [Tests from the nanoFramework.Logging](https://github.com/nanoframework/nanoFramework.Logging/tree/main/Tests/UnitTestDebugLogging), they gives as well advance scenarios. ## Build the sample diff --git a/samples/MQTT/README.md b/samples/MQTT/README.md index 11aa37921..15a894195 100644 --- a/samples/MQTT/README.md +++ b/samples/MQTT/README.md @@ -9,7 +9,7 @@ For more details, see the comments inside the samples. | Sample | Description | |---|---| |[🌶️🌶️ - BasicExample.Ethernet](./BasicExample.Ethernet)|The most basic usage, without authentication or certificates. Ready to run on Ethernet-based boards.| -|[🌶️🌶️ -BasicExample.Wifi](./BasicExample.Wifi)|The most basic usage, without authentication or certificates. Ready to run on Wifi-based boards.| +|[🌶️🌶️ -BasicExample.Wifi](./BasicExample.WiFi)|The most basic usage, without authentication or certificates. Ready to run on Wifi-based boards.| |[🌶️🌶️🌶️ - AdvancedExample.Certificates](./AdvancedExample.Certificates)|Basic usage, but uses secure connection and certificate-based authorization.| |[🌶️🌶️🌶️ - AdvancedExample.Aws](./AdvancedExample.Aws)|Very advanced sample of how to use MQTT in AWS. Requires having an AWS account.| |[🌶️🌶️🌶️ - AdvancedExample.Azure](./AdvancedExample.Azure)|Very advanced sample of how to use MQTT in Azure. Requires having an Azure account.| diff --git a/samples/Networking/README.md b/samples/Networking/README.md index 87df5120e..8ef4d15ac 100644 --- a/samples/Networking/README.md +++ b/samples/Networking/README.md @@ -5,7 +5,7 @@ Shows how to use network Sockets API. ## Samples - [🌶️🌶️ - Socket Client](Socket.Client/) -- [🌶️🌶️ - Socket Client (Wi-Fi connection)](Socket.Client_Wifi/) +- [🌶️🌶️ - Socket Client (Wi-Fi connection)](Socket.Client_WiFi/) Shows how to use various APIs related with networking. diff --git a/samples/SSL/README.md b/samples/SSL/README.md index 936c0281d..da9bfde0a 100644 --- a/samples/SSL/README.md +++ b/samples/SSL/README.md @@ -6,9 +6,9 @@ Shows how to use various APIs related with TLS (Transport Layer Security). - [🌶️🌶️ - Parsing a Certificate to access details](./ParseCertificate/) - [🌶️🌶️ - Secure Client for Ethernet connected devices](./SecureClient/) -- [🌶️🌶️ - Secure Client for ESP32 devices (Wi-Fi connection)](./SecureClient_ESP32/) +- [🌶️🌶️ - Secure Client for ESP32 devices (Wi-Fi connection)](./SecureClient_WiFi/) - [🌶️🌶️🌶️ - Secure Server for Ethernet connected devices](./SecureServer/) -- [🌶️🌶️🌶️ - Secure Server for ESP32 devices (Wi-Fi connection)](./SecureServer_ESP32/) +- [🌶️🌶️🌶️ - Secure Server for ESP32 devices (Wi-Fi connection)](./SecureServer_WiFi/) ## Test certificates diff --git a/samples/UsbClient/README.md b/samples/UsbClient/README.md index 89d70f272..90fdf7766 100644 --- a/samples/UsbClient/README.md +++ b/samples/UsbClient/README.md @@ -4,7 +4,7 @@ Shows how to use the [System.Device.UsbClient](http://docs.nanoframework.net/api ## Samples -- [UsbStream](UsbStream/) +- [UsbStream](UsbClient/UsbStream) ## Hardware requirements diff --git a/samples/WebSockets/README.md b/samples/WebSockets/README.md index 9a5936c49..9bbe6502d 100644 --- a/samples/WebSockets/README.md +++ b/samples/WebSockets/README.md @@ -12,7 +12,7 @@ Shows how to use the WebSockets related APIs in [System.Net.WebSockets](http://d ### WebSockets Client Sample -[🌶️ - Client.Sample](./Websockets.Client.Sample) shows how to use the Websocket Client. +[🌶️ - Client.Sample](./WebSockets.Client.Sample) shows how to use the Websocket Client. ### WebSockets Server and Client sample @@ -27,7 +27,7 @@ The Websocket Server Sample requires a M5Stack ATOM Lite board, but can be easil ### Reference -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) ## Building the samples diff --git a/samples/WebSockets/README.zh-cn.md b/samples/WebSockets/README.zh-cn.md index 5cc34755d..d223f130d 100644 --- a/samples/WebSockets/README.zh-cn.md +++ b/samples/WebSockets/README.zh-cn.md @@ -12,7 +12,7 @@ ### WebSockets Client 示例 -[🌶️ - Client.Sample](./Websockets.Client.Sample)展示了如何使用Websocket客户端。 +[🌶️ - Client.Sample](./WebSockets.Client.Sample)展示了如何使用Websocket客户端。 ### WebSockets Server 和 Client 示例 @@ -28,7 +28,7 @@ Websocket服务器样本需要一个M5Stack ATOM Lite板，但可以很容易地 ### 引用 -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) ## 构建样本 diff --git a/samples/WebSockets/WebSockets.Client.Sample/README.md b/samples/WebSockets/WebSockets.Client.Sample/README.md index 746ecdbcb..8092a2f2e 100644 --- a/samples/WebSockets/WebSockets.Client.Sample/README.md +++ b/samples/WebSockets/WebSockets.Client.Sample/README.md @@ -16,7 +16,7 @@ An hardware device with networking capabilities running a nanoFramework image. ### Reference -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [getting started guide](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) diff --git a/samples/WebSockets/WebSockets.Client.Sample/README.zh-cn.md b/samples/WebSockets/WebSockets.Client.Sample/README.zh-cn.md index fb637de53..f2337eb67 100644 --- a/samples/WebSockets/WebSockets.Client.Sample/README.zh-cn.md +++ b/samples/WebSockets/WebSockets.Client.Sample/README.zh-cn.md @@ -15,7 +15,7 @@ ### 参考 -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [getting started guide](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) diff --git a/samples/WebSockets/WebSockets.Server.RgbSample/README.md b/samples/WebSockets/WebSockets.Server.RgbSample/README.md index 7b8b35ca7..b846bcda9 100644 --- a/samples/WebSockets/WebSockets.Server.RgbSample/README.md +++ b/samples/WebSockets/WebSockets.Server.RgbSample/README.md @@ -16,7 +16,7 @@ This Sample was written for the [M5Stack ATOM Lite](https://shop.m5stack.com/pro ### Reference -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [getting started guide](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) diff --git a/samples/WebSockets/WebSockets.Server.RgbSample/README.zh-cn.md b/samples/WebSockets/WebSockets.Server.RgbSample/README.zh-cn.md index 0c1fd0d7d..e7719f8f4 100644 --- a/samples/WebSockets/WebSockets.Server.RgbSample/README.zh-cn.md +++ b/samples/WebSockets/WebSockets.Server.RgbSample/README.zh-cn.md @@ -16,7 +16,7 @@ ### 引用 -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [入门指南](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) diff --git a/samples/WebSockets/Websockets.ServerClient.Sample/README.md b/samples/WebSockets/Websockets.ServerClient.Sample/README.md index edd0739ba..91201efd0 100644 --- a/samples/WebSockets/Websockets.ServerClient.Sample/README.md +++ b/samples/WebSockets/Websockets.ServerClient.Sample/README.md @@ -16,7 +16,7 @@ This Sample was written for the [M5Stack ATOM Lite](https://shop.m5stack.com/pro ### Reference -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [getting started guide](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) diff --git a/samples/WebSockets/Websockets.ServerClient.Sample/README.zh-cn.md b/samples/WebSockets/Websockets.ServerClient.Sample/README.zh-cn.md index f9c5ebd1e..d0bf7d6b9 100644 --- a/samples/WebSockets/Websockets.ServerClient.Sample/README.zh-cn.md +++ b/samples/WebSockets/Websockets.ServerClient.Sample/README.zh-cn.md @@ -16,7 +16,7 @@ ### 引用 -- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/develop/README.md) +- [nanoFramework.Net.WebSockets](https://github.com/nanoframework/System.Net.WebSockets/blob/main/README.md) - [System.Net.WebSockets](http://docs.nanoframework.net/api/System.Net.WebSockets.html) - [入门指南](https://www.feiko.io/posts/2022-01-03-getting-started-with-net-nanoframework) @@ -46,4 +46,4 @@ > **Important**:在部署或运行示例之前，请确保您的设备在设备资源管理器中可见。 -> **Tip**:要显示设备资源管理器，请转到Visual Studio菜单:`View > Other Windows > Device Explorer`. \ No newline at end of file +> **Tip**:要显示设备资源管理器，请转到Visual Studio菜单:`View > Other Windows > Device Explorer`.