From a7ddf39521e7edd00651bd56d0a31a56aa9e9607 Mon Sep 17 00:00:00 2001 From: lbernstone Date: Mon, 30 Jul 2018 00:21:03 -0700 Subject: [PATCH] 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. --- README.md | 11 +++++------ docs/arduino-ide/boards_manager.md | 2 -- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1e2fecf2..22a81abe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# 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) +# 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) ### 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) @@ -12,15 +10,16 @@ - [ESP32Dev Board PINMAP](#esp32dev-board-pinmap) ## 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/) + +[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/) + 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: - 16 channels [LEDC](cores/esp32/esp32-hal-ledc.h) which is PWM - 8 channels [SigmaDelta](cores/esp32/esp32-hal-sigmadelta.h) which uses SigmaDelta modulation - 2 channels [DAC](cores/esp32/esp32-hal-dac.h) which gives real analog output ## Installation Instructions - -#### [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/) - - Using Arduino IDE Boards Manager (preferred) + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md) - Using Arduino IDE with the development repository diff --git a/docs/arduino-ide/boards_manager.md b/docs/arduino-ide/boards_manager.md index 921b72c4..9161ba6f 100644 --- a/docs/arduino-ide/boards_manager.md +++ b/docs/arduino-ide/boards_manager.md @@ -8,8 +8,6 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package - 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. - 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). -#### [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/) Stable release link: `https://dl.espressif.com/dl/package_esp32_index.json` -#### [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/) Development release link: `https://dl.espressif.com/dl/package_esp32_dev_index.json`