From a5c873b786ba3aa2c5ca3ff061de89e6862568c2 Mon Sep 17 00:00:00 2001 From: me-no-dev Date: Tue, 24 Sep 2019 23:32:13 +0300 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b4b397dd..76c15971 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,18 @@ ### 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) ## Contents +- [Development Status](#development-status) - [Installation Instructions](#installation-instructions) - [Decoding Exceptions](#decoding-exceptions) - [Issue/Bug report template](#issuebug-report-template) - [ESP32Dev Board PINMAP](#esp32dev-board-pinmap) -## Installation Instructions +### Development Status +[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) + +[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) + +### Installation Instructions - Using Arduino IDE Boards Manager (preferred) + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md) - Using Arduino IDE with the development repository @@ -23,19 +29,19 @@ - [Using as ESP-IDF component](docs/esp-idf_component.md) - [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md) -#### Decoding exceptions +### Decoding exceptions You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace. -#### Issue/Bug report template +### 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 [for reference](https://github.com/espressif/arduino-esp32/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3A%22for%20reference%22%20). Finally, if you're sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue. -## ESP32Dev Board PINMAP +### ESP32Dev Board PINMAP ![Pin Functions](docs/esp32_pinmap.png) -## Hint +### Hint Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process