From 637eda02c48d5a821a347cf1089eb2db2a6565fd Mon Sep 17 00:00:00 2001 From: fvanroie Date: Thu, 17 Dec 2020 00:52:48 +0100 Subject: [PATCH] Use flexible alerts --- docs/01-hardware.md | 8 +++++--- docs/02-installation.md | 6 ++++-- docs/03-wifi-setup.md | 3 ++- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/01-hardware.md b/docs/01-hardware.md index d6cc7609..6687296e 100644 --- a/docs/01-hardware.md +++ b/docs/01-hardware.md @@ -44,7 +44,7 @@ table th:last-of-type { > \* *Due to the large number of possible hardware options a selection of 3 popular ESP development boards has been made for the precompiled binaries.* > [!NOTE] -> **Note:**
Advanced users can build and compile custom configurations using PlatformIO, however this is not currently supported. +> Advanced users can build and compile custom configurations using PlatformIO, however this is not currently supported. ## Recommended Display @@ -71,7 +71,8 @@ To use PWM dimming on the Lolin TFT 2.4" you must solder the TFT-LED pin to eith > [!WARNING] > **Warning:**
Do *not* use D3 for backlight control because it is already in use for touch! -> **Note:**
It is also *not* recommended to use D4 for backlight control because it is already in use for PSram on the ESP32-Wrover. +> [!ATTENTION] +> It is also *not* recommended to use D4 for backlight control because it is already in use for PSram on the ESP32-Wrover. ##### Compatible ESP boards @@ -151,6 +152,7 @@ The following boards are being tested: - Documentation can be found on [GitHub](https://github.com/mcauser/BLACK_F407ZG) -> **Note:**
The STM32F4 boards do not have network connectivity. You can use a compatible network adapter and configure it in PlatformIO. +> [!NOTE] +> The STM32F4 boards do not have network connectivity. You can use a compatible network adapter and configure it in PlatformIO. Images of STM32 boards are [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) from https://stm32-base.org/ \ No newline at end of file diff --git a/docs/02-installation.md b/docs/02-installation.md index 0b47bd17..3c8f10c9 100644 --- a/docs/02-installation.md +++ b/docs/02-installation.md @@ -8,7 +8,8 @@ There are currently 2 download options, pick the one appropriate for your hardwa - hasp-lvgl-0.2.0-esp32_ili9341_spi.bin - hasp-lvgl-0.2.0-esp8266_ili9341_spi.bin + boot files -> **Note:**
If no precompiled firmware file is available for your board you can configure, compile and upload the firmware yourself using PlatformIO. +> [!NOTE] +> If no precompiled firmware file is available for your board you can configure, compile and upload the firmware yourself using PlatformIO. ## Install the firmware @@ -55,7 +56,8 @@ Change `COM1` to the correct port on your computer and `4m` to the correct size ### STM32F407 devEbox -> **Note:**
There is no precompiled firmware file available for STM32F4 boards. You will need to configure, compile and upload the firmware yourself using PlatformIO. +> [!NOTE] +> There is no precompiled firmware file available for STM32F4 boards. You will need to configure, compile and upload the firmware yourself using PlatformIO. #### Using Serial diff --git a/docs/03-wifi-setup.md b/docs/03-wifi-setup.md index 892cf2bd..212fe1f7 100644 --- a/docs/03-wifi-setup.md +++ b/docs/03-wifi-setup.md @@ -38,5 +38,6 @@ pass myWifiPassword reboot ``` -> **Note:**
To skip this step, wifi credentials can be saved into the .bin file when you compile the firmware yourself. +> [!TIP] +> To skip this step, wifi credentials can be saved into the .bin file when you compile the firmware yourself.