Skip to content

Commit 30ec082

Browse files
committed
Cleanup on README and boards_manager (#1693)
* Added instructions for installation with boards manager (stolen directly from esp8266) * changed to production link instead of dev * Added to main README. Made mods to images as requested. * Added links for development package * Moved version images to README.md * Just a little change for cleaner look * Cleaned up README.md and boards_manager.md to make installation easier.
1 parent 2d5d2a7 commit 30ec082

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Arduino core for ESP32 WiFi chip
2-
3-
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32)
1+
# Arduino core for ESP32 WiFi chip [![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32)
42

53
### 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)
64

@@ -12,15 +10,16 @@
1210
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
1311

1412
## Development Status
13+
[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/)
14+
15+
[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/)
16+
1517
Most of the framework is implemented. Most noticable is the missing analogWrite. While analogWrite is on it's way, there are a few other options that you can use:
1618
- 16 channels [LEDC](cores/esp32/esp32-hal-ledc.h) which is PWM
1719
- 8 channels [SigmaDelta](cores/esp32/esp32-hal-sigmadelta.h) which uses SigmaDelta modulation
1820
- 2 channels [DAC](cores/esp32/esp32-hal-dac.h) which gives real analog output
1921

2022
## Installation Instructions
21-
22-
#### [Latest release ![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.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/)
23-
2423
- Using Arduino IDE Boards Manager (preferred)
2524
+ [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
2625
- Using Arduino IDE with the development repository

docs/arduino-ide/boards_manager.md

-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
88
- Enter ```https://dl.espressif.com/dl/package_esp32_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
99
- Open Boards Manager from Tools > Board menu and install *esp32* platform (and don't forget to select your ESP32 board from Tools > Board menu after installation).
1010

11-
#### [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/)
1211
Stable release link: `https://dl.espressif.com/dl/package_esp32_index.json`
1312

14-
#### [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/)
1513
Development release link: `https://dl.espressif.com/dl/package_esp32_dev_index.json`

0 commit comments

Comments
 (0)