Skip to content

Commit 698a6ab

Browse files
committed
Update readme and change log
1 parent e1e7ace commit 698a6ab

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
Arduino-compatible IDE with ESP8266 support
1+
Arduino core for ESP8266 WiFi chip
22
===========================================
33

4-
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.
4+
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.
5+
6+
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.
57

68
### Installing with Boards Manager ###
79

@@ -41,9 +43,12 @@ Documentation for latest development version:
4143

4244
### Issues and support ###
4345

44-
Forum: http://www.esp8266.com/arduino
46+
The best place to ask questions related to this core is ESP8266 community forum: http://www.esp8266.com/arduino.
47+
If you find the forum useful, please consider supporting it with a donation.
48+
[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66)
4549

46-
Submit issues on Github: https://github.com/esp8266/Arduino/issues
50+
If you encounter an issue, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues.
51+
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).
4752

4853
### Contributing
4954

hardware/esp8266com/esp8266/doc/changes.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@ title: Change log
44

55
*Current release*
66

7+
### Core
8+
9+
- Add first batch of file system APIs
10+
- Allow user to run code in user_rf_pre_init
11+
12+
13+
### Libraries
14+
15+
- ESP8266WebServer: support for sending of PROGMEM strings
16+
- ESP8266WiFi: fix mode selection (#529)
17+
18+
### Tools
19+
20+
- Update SDK to 1.2.0_15_07_13_p4
721

822
---
923
## 1.6.5-947-g39819f0

0 commit comments

Comments
 (0)