Skip to content

Commit 34f15c0

Browse files
committed
feat(support): documentation adjustment
1 parent 857935c commit 34f15c0

File tree

4 files changed

+6
-95
lines changed

4 files changed

+6
-95
lines changed

Diff for: docs/_static/logo_pio.png

-25.4 KB
Binary file not shown.

Diff for: docs/en/getting_started.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,13 @@ Supported IDEs
7878

7979
Here is the list of supported IDE for Arduino ESP32 support integration.
8080

81-
+-------------------+-------------------+
82-
| |arduino-logo| | |pio-logo| |
83-
+-------------------+-------------------+
84-
| Arduino IDE | PlatformIO |
85-
+-------------------+-------------------+
81+
+-------------------+
82+
| |arduino-logo| |
83+
+-------------------+
84+
| Arduino IDE |
85+
+-------------------+
8686

8787
.. |arduino-logo| image:: ../_static/logo_arduino.png
88-
.. |pio-logo| image:: ../_static/logo_pio.png
8988

9089
See `Installing Guides <installing.html>`_ for more details on how to install the Arduino ESP32 support.
9190

Diff for: docs/en/installing.rst

-87
Original file line numberDiff line numberDiff line change
@@ -63,92 +63,6 @@ To start the installation process using the Boards Manager, follow these steps:
6363

6464
- Restart Arduino IDE.
6565

66-
Installing using PlatformIO
67-
---------------------------
68-
69-
.. figure:: ../_static/logo_pio.png
70-
:align: center
71-
:width: 200
72-
:figclass: align-center
73-
74-
PlatformIO is a professional collaborative platform for embedded development. It has out-of-the-box support for ESP32 SoCs and allows working with Arduino ESP32 as well as ESP-IDF from Espressif without changing your development environment. PlatformIO includes lots of instruments for the most common development tasks such as debugging, unit testing, and static code analysis.
75-
76-
.. warning:: Integration of the Arduino Core ESP32 project in PlatformIO is maintained by PlatformIO developers. Arduino Core ESP32 Project Team cannot support PlatformIO-specific issues. Please report these issues in official `PlatformIO repositories <https://github.com/platformio>`_.
77-
78-
A detailed overview of the PlatformIO ecosystem and its philosophy can be found in `the official documentation <https://docs.platformio.org/en/latest/core/index.html>`_.
79-
80-
PlatformIO can be used in two flavors:
81-
82-
- `PlatformIO IDE <https://platformio.org/platformio-ide>`_ is a toolset for embedded C/C++ development available on Windows, macOS and Linux platforms
83-
84-
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_ is a command-line tool that consists of a multi-platform build system, platform and library managers and other integration components. It can be used with a variety of code development environments and allows integration with cloud platforms and web services
85-
86-
To install PlatformIO, you can follow this Getting Started, provided at `docs.platformio.org`_.
87-
88-
Using the stable code
89-
*********************
90-
91-
.. note::
92-
A detailed overview of supported development boards, examples and frameworks can be found on `the official Espressif32 dev-platform page <https://registry.platformio.org/platforms/platformio/espressif32>`_ in the PlatformIO Registry.
93-
94-
The most reliable and easiest way to get started is to use the latest stable version of the ESP32 development platform that passed all tests/verifications and can be used in production.
95-
96-
Create a new project and select one of the available boards. You can change after by changing the `platformio.ini <https://docs.platformio.org/en/latest/projectconf/index.html>`_ file.
97-
98-
- For ESP32
99-
100-
.. code-block:: bash
101-
102-
[env:esp32dev]
103-
platform = espressif32
104-
board = esp32dev
105-
framework = arduino
106-
107-
- For ESP32-S2 (ESP32-S2-Saola-1 board)
108-
109-
.. code-block:: bash
110-
111-
[env:esp32-s2-saola-1]
112-
platform = espressif32
113-
board = esp32-s2-saola-1
114-
framework = arduino
115-
116-
- For ESP32-C3 (ESP32-C3-DevKitM-1 board)
117-
118-
.. code-block:: bash
119-
120-
[env:esp32-c3-devkitm-1]
121-
platform = espressif32
122-
board = esp32-c3-devkitm-1
123-
framework = arduino
124-
125-
How to update to the latest code
126-
********************************
127-
128-
To test the latest Arduino ESP32, you need to change your project *platformio.ini* accordingly.
129-
The following configuration uses the upstream version of the Espressif development platform and the latest Arduino core directly from the Espressif GitHub repository:
130-
131-
.. code-block:: bash
132-
133-
[env:esp32-c3-devkitm-1]
134-
platform = https://github.com/platformio/platform-espressif32.git
135-
board = esp32-c3-devkitm-1
136-
framework = arduino
137-
platform_packages =
138-
framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32#master
139-
140-
141-
To get more information about PlatformIO, see the following links:
142-
143-
- `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html>`_
144-
145-
- `PlatformIO Home <https://docs.platformio.org/en/latest/home/index.html>`_
146-
147-
- `Tutorials and Examples <https://docs.platformio.org/en/latest/tutorials/index.html>`_
148-
149-
- `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html>`_
150-
151-
15266
Windows (manual installation)
15367
-----------------------------
15468

@@ -360,4 +274,3 @@ Where ``~/Documents/Arduino`` represents your sketch book location as per "Ardui
360274
- Restart Arduino IDE.
361275

362276
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
363-
.. _docs.platformio.org: https://docs.platformio.org/en/latest/integration/ide/pioide.html

Diff for: docs/en/tutorials/blink.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Introduction
77

88
This is the interactive blink tutorial using `Wokwi`_. For this tutorial, you don't need the ESP32 board or the Arduino toolchain.
99

10-
.. note:: If you don't want to use this tutorial with the simulation, you can copy and paste the :ref:`blink_example_code` from `Wokwi`_ editor and use it on the `Arduino IDE`_ or `PlatformIO`_.
10+
.. note:: If you don't want to use this tutorial with the simulation, you can copy and paste the :ref:`blink_example_code` from `Wokwi`_ editor and use it on the `Arduino IDE` _.
1111

1212
About this Tutorial
1313
-------------------
@@ -109,5 +109,4 @@ Resources
109109

110110
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
111111
.. _Wokwi: https://wokwi.com/
112-
.. _PlatformIO: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#platformio
113112
.. _Arduino IDE: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager

0 commit comments

Comments
 (0)