Skip to content

Commit b1a1f32

Browse files
cziter15Jason2866
andauthored
Add info about the origin, add IDE preparation section (#7)
* Update README.md * Update README.md * Update README.md --------- Co-authored-by: Jason2866 <[email protected]>
1 parent ab57d95 commit b1a1f32

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,35 @@
33

44
[![Build Status](https://github.com/pioarduino/platform-espressif32/workflows/Examples/badge.svg)](https://github.com/pioarduino/platform-espressif32/actions)
55

6+
> [!NOTE]
7+
> This fork was created due to the lack of ongoing development for the Espressif 32 Arduino Core for PlatformIO.
8+
>
9+
> For additional information, please refer to these GitHub links:
10+
>
11+
> https://github.com/espressif/arduino-esp32/discussions/10039
12+
> https://github.com/platformio/platform-espressif32/issues/1225
13+
> https://github.com/espressif/arduino-esp32/pull/8606
14+
>
15+
> The discussions are self-explanatory, allowing you to draw your own conclusions.
16+
617
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.
718

819
* [Documentation](https://docs.platformio.org/page/platforms/espressif32.html) (advanced usage, packages, boards, frameworks, etc.)
920

10-
# Usage
21+
## IDE Preparation
22+
23+
- [Download and install official Microsoft Visual Studio Code](https://code.visualstudio.com/). PlatformIO IDE is built on top of it.
24+
- Open the extension manager.
25+
- Search for the official `platformio ide` extension.
26+
- Install PlatformIO IDE extension.
1127

12-
1. [Install PlatformIO](https://platformio.org)
13-
2. Create PlatformIO project and configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file:
28+
![image](https://github.com/user-attachments/assets/9549991b-6a8b-4d77-ad9f-3b08873d7e30)
29+
30+
# Usage
31+
1. Setup new VSCode PlatformIO project.
32+
1. Configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file:
1433

15-
## Stable version
34+
### Stable version
1635
espressif Arduino 3.0.3 and IDF 5.1.4
1736

1837
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 = ...
2443
...
2544
```
2645

27-
## Development version
46+
### Development version
2847

2948
```ini
3049
[env:development]

0 commit comments

Comments
 (0)