mirror of
https://github.com/0xFEEDC0DE64/arduino-esp32.git
synced 2025-10-05 10:20:55 +02:00
9f827a66d5
* Create PULL_REQUEST_TEMPLATE.md Adding first version of PULL_REQUEST_TEMPLATE.md. The purpose of this template is to improve and simplify writing more accurate Release Notes. * Update PULL_REQUEST_TEMPLATE.md Fix typo. * Update README.MD - "Type: For reference" labels link Updating a link to issues labeled with "Type: For reference". The old one is not working due to the updates of labels in the past.
55 lines
3.8 KiB
Markdown
55 lines
3.8 KiB
Markdown
# Arduino core for the ESP32
|
|
|
|
[](https://travis-ci.org/espressif/arduino-esp32)  [](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest)
|
|
|
|
### Need help or have a question? Join the chat at [](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
## Contents
|
|
|
|
- [ESP32-S2 and ESP32-C3 Support](#esp32-s2-and-esp32-c3-support)
|
|
- [Development Status](#development-status)
|
|
- [Decoding Exceptions](#decoding-exceptions)
|
|
- [Issue/Bug report template](#issuebug-report-template)
|
|
|
|
### ESP32-S2 and ESP32-C3 Support
|
|
|
|
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
|
|
```
|
|
|
|
Now you can install the latest 2.0.0 version from the boards manager.
|
|
|
|
### Development Status
|
|
|
|
Latest Stable Release [](https://github.com/espressif/arduino-esp32/releases/latest/) [](https://github.com/espressif/arduino-esp32/releases/latest/) [](https://github.com/espressif/arduino-esp32/releases/latest/)
|
|
|
|
Latest Development Release [](https://github.com/espressif/arduino-esp32/releases/) [](https://github.com/espressif/arduino-esp32/releases/) [](https://github.com/espressif/arduino-esp32/releases/)
|
|
|
|
### Documentation
|
|
|
|
You can use [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/) to get all information about this project.
|
|
|
|
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
|
|
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
|
|
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)
|
|
* [ESP-IDF as Component](https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html)
|
|
* [FAQ](https://docs.espressif.com/projects/arduino-esp32/en/latest/faq.html)
|
|
* [Troubleshooting](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html)
|
|
|
|
### Decoding exceptions
|
|
|
|
You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.
|
|
|
|
### Issue/Bug report template
|
|
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 [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+).
|
|
|
|
Finally, if you are sure no one else had the issue, follow the [issue template](docs/ISSUE_TEMPLATE.md) while reporting any issue.
|
|
|
|
### Contributing
|
|
|
|
We welcome contributions to the Arduino ESP32 project!
|
|
|
|
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.
|