From 010a1a9f01c2fb95c522b0455645099bdc80ba75 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Tue, 28 Jul 2015 20:08:21 +0300 Subject: [PATCH] Update readme and change log --- README.md | 13 +++++++++---- doc/changes.md | 14 ++++++++++++++ 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 65da26bb22..c73cd8917c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -Arduino-compatible IDE with ESP8266 support +Arduino core for ESP8266 WiFi chip =========================================== -This project brings support for ESP8266 chip to the Arduino environment. ESP8266WiFi library bundled with this project has the same interface as the WiFi Shield library, making it easy to re-use existing code and libraries. +This project brings support for ESP8266 chip to the Arduino environment. It lets you write sketches using familiar Arduino functions and libraries, and run them directly on ESP8266, no external microcontroller required. + +ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and UDP, set up HTTP, mDNS, SSDP, and DNS servers, do OTA updates, use a file system in flash memory, work with SD cards, servos, SPI and I2C peripherals. ### Installing with Boards Manager ### @@ -41,9 +43,12 @@ Documentation for latest development version: ### Issues and support ### -Forum: http://www.esp8266.com/arduino +The best place to ask questions related to this core is ESP8266 community forum: http://www.esp8266.com/arduino. +If you find the forum useful, please consider supporting it with a donation. +[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66) -Submit issues on Github: https://github.com/esp8266/Arduino/issues +If you encounter an issue, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues. +Please provide as much context as possible: version which you are using (you can check it in Boards Manager), your sketch code, serial output, board model, IDE settings (board selection, flash size, etc). ### Contributing diff --git a/doc/changes.md b/doc/changes.md index 9585702515..7d7064a84b 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -4,6 +4,20 @@ title: Change log *Current release* +### Core + +- Add first batch of file system APIs +- Allow user to run code in user_rf_pre_init + + +### Libraries + +- ESP8266WebServer: support for sending of PROGMEM strings +- ESP8266WiFi: fix mode selection (#529) + +### Tools + +- Update SDK to 1.2.0_15_07_13_p4 --- ## 1.6.5-947-g39819f0