Skip to content

Commit ea17a06

Browse files
dickorydockdevyte
authored andcommitted
Grammar edits in documentation (esp8266#6401)
* Grammar changes * Update readme.rst * Update README.md
1 parent 021a81f commit ea17a06

File tree

2 files changed

+40
-41
lines changed

2 files changed

+40
-41
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Arduino core for ESP8266 WiFi chip
99

1010
# Arduino on ESP8266
1111

12-
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.
12+
This project brings support for the ESP8266 chip to the Arduino environment. It lets you write sketches, using familiar Arduino functions and libraries, and run them directly on ESP8266, with no external microcontroller required.
1313

14-
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.
14+
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, and work with SD cards, servos, SPI and I2C peripherals.
1515

1616
# Contents
1717
- Installing options:
@@ -71,9 +71,9 @@ python get.py
7171
### Using PlatformIO
7272

7373
[PlatformIO](https://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT
74-
development with a cross-platform build system, library manager and full support
75-
for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows,
76-
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
74+
development with a cross-platform build system, a library manager, and full support
75+
for Espressif (ESP8266) development. It works on the following popular host operating systems: macOS, Windows,
76+
Linux 32/64, and Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
7777

7878
- [What is PlatformIO?](https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266)
7979
- [PlatformIO IDE](https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266)
@@ -95,7 +95,7 @@ Documentation for latest development version: https://arduino-esp8266.readthedoc
9595

9696
### Issues and support ###
9797

98-
[ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a well-established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party lib not hosted in this repo, or just want to discuss how to approach a problem, please ask there.
98+
[ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a well-established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party library not hosted in this repo, or just want to discuss how to approach a problem, please ask there.
9999

100100
If you find the forum useful, please consider supporting it with a donation. <br />
101101
[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66)
@@ -107,7 +107,7 @@ Please provide as much context as possible, as well as the information requested
107107
- ESP8266 Arduino core version which you are using (you can check it in Boards Manager)
108108
- your sketch code; please wrap it into a code block, see [Github markdown manual](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code)
109109
- when encountering an issue that happens at run time, attach the serial output. Wrap it into a code block, just like the code.
110-
- for issues which happen at compile time, enable verbose compiler output in the IDE preferences, and attach that output (also inside a code block)
110+
- for issues that happen at compile time, enable verbose compiler output in the IDE preferences, and attach that output (also inside a code block)
111111
- ESP8266 development board model
112112
- IDE settings (board choice, flash size)
113113
- etc

0 commit comments

Comments
 (0)