Skip to content

Commit 8caf585

Browse files
committed
Work in progress on the Getting started and install guide
1 parent 38169b0 commit 8caf585

File tree

3 files changed

+37
-9
lines changed

3 files changed

+37
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
- [Installation Instructions](#installation-instructions)
1010
- [Decoding Exceptions](#decoding-exceptions)
1111
- [Issue/Bug report template](#issuebug-report-template)
12-
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
1312

1413
### ESP32-S2 and ESP32-C3 Support
1514
If you want to test ESP32-S2 and/or ESP32-C3 through the board manager, please use the development release link: `https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json` and install the latest 2.0.0 version.
@@ -22,6 +21,7 @@ Latest Development Release [![Release Version](https://img.shields.io/github/re
2221

2322

2423
### Installation Instructions
24+
2525
- Using Arduino IDE Boards Manager (preferred)
2626
+ [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
2727
- Using Arduino IDE with the development repository
@@ -30,9 +30,9 @@ Latest Development Release [![Release Version](https://img.shields.io/github/re
3030
+ [Instructions for Debian/Ubuntu Linux](docs/arduino-ide/debian_ubuntu.md)
3131
+ [Instructions for Fedora](docs/arduino-ide/fedora.md)
3232
+ [Instructions for openSUSE](docs/arduino-ide/opensuse.md)
33-
- [Using PlatformIO](docs/platformio.md)
33+
- REMOVE: [Using PlatformIO](docs/platformio.md)
3434
- [Building with make](docs/make.md)
35-
- [Using as ESP-IDF component](docs/esp-idf_component.md)
35+
- REMOVE: [Using as ESP-IDF component](docs/esp-idf_component.md)
3636
- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md)
3737

3838
### Decoding exceptions

docs/source/getting_started.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,8 @@ About Arduino ESP32
77
How to Contribute
88
-----------------
99

10-
Installation
11-
------------
10+
Supported Operational Systems
11+
-----------------------------
12+
13+
Currently, the supported OS are: Windows, Linux and macOS.
14+

docs/source/installing.rst

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1+
**********
12
Installing
2-
==========
3+
**********
34

45
Before Installing
56
-----------------
67

8+
9+
710
Installing using Boards Manager
811
-------------------------------
912

1013
- Stable release link:
11-
``https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json``
14+
15+
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
16+
1217
- Development release link:
13-
``https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json``
18+
19+
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json
1420

1521
Starting with 1.6.4, Arduino allows installation of third-party platform
1622
packages using Boards Manager. We have packages available for Windows,
@@ -33,4 +39,23 @@ Linux
3339
-----
3440

3541
MacOS
36-
-----
42+
-----
43+
44+
45+
PlatformIO
46+
----------
47+
48+
Installation instructions for using PlatformIO
49+
**********************************************
50+
51+
`What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp32>`_
52+
53+
`PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp32>`_
54+
55+
`PlatformIO Core <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp32>`_
56+
57+
`Advanced usage <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32>`_: Custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
58+
59+
`Integration with Cloud and Standalone IDEs <https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp32>`_: Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
60+
61+
`Project Examples <https://docs.platformio.org/en/latest/platforms/espressif32.html?utm_source=github&utm_medium=arduino-esp32#examples>`_

0 commit comments

Comments
 (0)