Skip to content

Commit cc35049

Browse files
Updating index.md
1 parent 3461a0e commit cc35049

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

index.md

+33-26
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,42 @@
11
# Arduino core for the ESP32
2-
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg)
2+
3+
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![Documentation Status](https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest)](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest)
34

45
### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
56

67
## Contents
8+
9+
- [ESP32-S2 and ESP32-C3 Support](#esp32-s2-and-esp32-c3-support)
710
- [Development Status](#development-status)
8-
- [Installation Instructions](#installation-instructions)
911
- [Decoding Exceptions](#decoding-exceptions)
1012
- [Issue/Bug report template](#issuebug-report-template)
11-
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
13+
14+
### ESP32-S2 and ESP32-C3 Support
15+
16+
If you want to test ESP32-S2 and/or ESP32-C3 through the board manager, please use the development release link:
17+
18+
```
19+
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json
20+
```
21+
22+
Now you can install the latest 2.0.0 version from the boards manager.
1223

1324
### Development Status
14-
[Latest stable release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic) ![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) ![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)
15-
16-
[Latest development release ![Development Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic) ![Development Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) ![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)
17-
18-
### Installation Instructions
19-
- Using Arduino IDE Boards Manager (preferred)
20-
+ [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
21-
- Using Arduino IDE with the development repository
22-
+ [Instructions for Windows](docs/arduino-ide/windows.md)
23-
+ [Instructions for Mac](docs/arduino-ide/mac.md)
24-
+ [Instructions for Debian/Ubuntu Linux](docs/arduino-ide/debian_ubuntu.md)
25-
+ [Instructions for Fedora](docs/arduino-ide/fedora.md)
26-
+ [Instructions for openSUSE](docs/arduino-ide/opensuse.md)
27-
- [Using PlatformIO](docs/platformio.md)
28-
- [Building with make](docs/make.md)
29-
- [Using as ESP-IDF component](docs/esp-idf_component.md)
30-
- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md)
25+
26+
Latest Stable Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
27+
28+
Latest Development Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
29+
30+
### Documentation
31+
32+
You can use [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/) to get all information about this project.
33+
34+
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
35+
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
36+
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)
37+
* [ESP-IDF as Component](https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html)
38+
* [FAQ](https://docs.espressif.com/projects/arduino-esp32/en/latest/faq.html)
39+
* [Troubleshooting](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html)
3140

3241
### Decoding exceptions
3342

@@ -36,12 +45,10 @@ You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecod
3645
### Issue/Bug report template
3746
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [for reference](https://github.com/espressif/arduino-esp32/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3A%22for%20reference%22%20).
3847

39-
Finally, if you are sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.
40-
41-
### ESP32Dev Board PINMAP
48+
Finally, if you are sure no one else had the issue, follow the [issue template](docs/ISSUE_TEMPLATE.md) while reporting any issue.
4249

43-
![Pin Functions](docs/esp32_pinmap.png)
50+
### Contributing
4451

45-
### Tip
52+
We welcome contributions to the Arduino ESP32 project!
4653

47-
Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process
54+
See [contributing](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html) in the documentation for more information on how to contribute to the project.

0 commit comments

Comments
 (0)