From 1ba2fdd45fc4670cfac2fc271b88c2c5ebdbb941 Mon Sep 17 00:00:00 2001 From: Jason2866 <24528715+Jason2866@users.noreply.github.com> Date: Mon, 16 Dec 2024 21:52:20 +0100 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++----------------------------- 1 file changed, 9 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 417f812..5b4f5f0 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,26 @@ # pioarduino (p)eople (i)nitiated (o)ptimized (arduino) -# Fork of Platformio Espressif 32: development platform for [PlatformIO](https://platformio.org) [![Build Status](https://github.com/pioarduino/platform-espressif32/workflows/Examples/badge.svg)](https://github.com/pioarduino/platform-espressif32/actions) [![Discord](https://img.shields.io/discord/1263397951829708871.svg?logo=discord&logoColor=white&color=5865F2&label=Discord)](https://discord.gg/Nutz9crnZr) [![GitHub Releases](https://img.shields.io/github/downloads/pioarduino/platform-espressif32/total?label=downloads)](https://github.com/pioarduino/platform-espressif32/releases/latest) -> [!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.) -* Issues with boards (wrong / missing). All issues caused from boards will not be fixed from the maintainer(s). A PR needs to be provided to solve. +* Issues with boards (wrong / missing). All issues caused from boards will **not** be fixed from the maintainer(s). A PR needs to be provided to solve. ## IDE Preparation -- [Download and install official Microsoft Visual Studio Code](https://code.visualstudio.com/). PlatformIO IDE is built on top of it. +- [Download and install official Microsoft Visual Studio Code](https://code.visualstudio.com/). pioarduino IDE is built on top of it. - Open the extension manager. -- Search for the official `platformio ide` extension. -- Install PlatformIO IDE extension. - -![image](idesetup.png) +- Search for the `pioarduino ide` extension. +- Install pioarduino IDE extension. # Usage -1. Setup new VSCode PlatformIO project. -1. Configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file: +1. Setup new VSCode pioarduino project. +1. Configure a platform option in platformio.ini file: ### Stable version - -See `platform` [documentation](https://docs.platformio.org/en/latest/projectconf/sections/env/options/platform/platform.html#projectconf-env-platform) for details. +currently espressif Arduino 3.1.0 and IDF 5.3.2.241210 ```ini [env:stable] @@ -46,15 +30,11 @@ board = ... ``` ### Development version -based on devel branch Arduino 3.1.0 and IDF 5.3.2 +espressif Arduino repo branch master and latest compiled Arduino libs ```ini [env:development] -platform = https://github.com/pioarduino/platform-espressif32.git#Arduino/IDF53 +platform = https://github.com/pioarduino/platform-espressif32.git#develop board = ... ... ``` - -# Configuration - -Please navigate to [documentation](https://docs.platformio.org/page/platforms/espressif32.html).