From b1a1f322ec60dd70207c4fb4b1078fc9aac158c4 Mon Sep 17 00:00:00 2001 From: Krzysztof Strehlau Date: Thu, 18 Jul 2024 13:23:30 +0200 Subject: [PATCH] Add info about the origin, add IDE preparation section (#7) * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Jason2866 <24528715+Jason2866@users.noreply.github.com> --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b95d611..a2f794d 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,35 @@ [![Build Status](https://github.com/pioarduino/platform-espressif32/workflows/Examples/badge.svg)](https://github.com/pioarduino/platform-espressif32/actions) +> [!NOTE] +> This fork was created due to the lack of ongoing development for the Espressif 32 Arduino Core for PlatformIO. +> +> For additional information, please refer to these GitHub links: +> +> https://github.com/espressif/arduino-esp32/discussions/10039 +> https://github.com/platformio/platform-espressif32/issues/1225 +> https://github.com/espressif/arduino-esp32/pull/8606 +> +> The discussions are self-explanatory, allowing you to draw your own conclusions. + ESP32 is a series of low-cost, low-power system on a chip microcontrollers with integrated Wi-Fi and Bluetooth. ESP32 integrates an antenna switch, RF balun, power amplifier, low-noise receive amplifier, filters, and power management modules. * [Documentation](https://docs.platformio.org/page/platforms/espressif32.html) (advanced usage, packages, boards, frameworks, etc.) +## IDE Preparation + +- [Download and install official Microsoft Visual Studio Code](https://code.visualstudio.com/). PlatformIO IDE is built on top of it. +- Open the extension manager. +- Search for the official `platformio ide` extension. +- Install PlatformIO IDE extension. + +![image](https://github.com/user-attachments/assets/9549991b-6a8b-4d77-ad9f-3b08873d7e30) + # Usage +1. Setup new VSCode PlatformIO project. +1. Configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file: -1. [Install PlatformIO](https://platformio.org) -2. Create PlatformIO project and configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file: - -## Stable version +### Stable version espressif Arduino 3.0.3 and IDF 5.1.4 See `platform` [documentation](https://docs.platformio.org/en/latest/projectconf/sections/env/options/platform/platform.html#projectconf-env-platform) for details. @@ -24,7 +43,7 @@ board = ... ... ``` -## Development version +### Development version ```ini [env:development]