Skip to content

Commit ec7bdfa

Browse files
race2infinityearlephilhower
authored andcommitted
Fix editing, typos and grammatical errors (#6207)
1. The current version is ~at~ on the Arduino website 2. Start Arduino and open _the_ Preferences window 3. Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into _the_ *Additional Board Manager URLs* field 4. The current version is ~at~ on the Arduino website 5. [PlatformIO](https://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT development with _a_ ~cross platform~ cross-platform build system, library manager and full support 6. [ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a ~well established~ well-established community 7. or just want to discuss how to approach a problem, (removed extra space after 'problem') 8. when encountering an issue ~which~ that happens at run time 9. attach _the_ serial output 10. Check out the list of issues ~which~ that are easy to fix 11. It is distributed under _the_ MIT license. 12. It is distributed under _the_ MIT license.
1 parent 59db907 commit ec7bdfa

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
2828

2929
Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).
3030

31-
- Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software).
32-
- Start Arduino and open Preferences window.
33-
- Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
31+
- Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is on the [Arduino website](https://www.arduino.cc/en/main/software).
32+
- Start Arduino and open the Preferences window.
33+
- Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into the *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
3434
- Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
3535

3636
#### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)
@@ -41,7 +41,7 @@ Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.2/](https://arduin
4141
### Using git version (basic instructions)
4242
[![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
4343

44-
- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software).
44+
- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is on the [Arduino website](https://www.arduino.cc/en/main/software).
4545
- Go to Arduino directory
4646
- For Mac OS X, it is `Arduino.app` showing as the Arduino icon.
4747
This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
@@ -71,7 +71,7 @@ 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 cross platform build system, library manager and full support
74+
development with a cross-platform build system, library manager and full support
7575
for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows,
7676
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
7777

@@ -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 lib 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)
@@ -106,7 +106,7 @@ Please provide as much context as possible, as well as the information requested
106106

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)
109-
- when encountering an issue which happens at run time, attach serial output. Wrap it into a code block, just like the code.
109+
- when encountering an issue that happens at run time, attach the serial output. Wrap it into a code block, just like the code.
110110
- for issues which 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)
@@ -116,7 +116,7 @@ Please provide as much context as possible, as well as the information requested
116116

117117
For minor fixes of code and documentation, please go ahead and submit a pull request.
118118

119-
Check out the list of issues which are easy to fix — [easy issues pending](https://github.com/esp8266/Arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22level%3A+easy%22). Working on them is a great way to move the project forward.
119+
Check out the list of issues that are easy to fix — [easy issues pending](https://github.com/esp8266/Arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22level%3A+easy%22). Working on them is a great way to move the project forward.
120120

121121
Larger changes (rewriting parts of existing code from scratch, adding new functions to the core, adding new libraries) should generally be discussed by opening an issue first.
122122

@@ -134,9 +134,9 @@ Espressif SDK included in this build is under Espressif MIT License.
134134

135135
ESP8266 core files are licensed under LGPL.
136136

137-
[SPI Flash File System (SPIFFS)](https://github.com/pellepl/spiffs) written by Peter Andersson is used in this project. It is distributed under MIT license.
137+
[SPI Flash File System (SPIFFS)](https://github.com/pellepl/spiffs) written by Peter Andersson is used in this project. It is distributed under the MIT license.
138138

139-
[umm_malloc](https://github.com/rhempel/umm_malloc) memory management library written by Ralph Hempel is used in this project. It is distributed under MIT license.
139+
[umm_malloc](https://github.com/rhempel/umm_malloc) memory management library written by Ralph Hempel is used in this project. It is distributed under the MIT license.
140140

141141
[SoftwareSerial](https://github.com/plerup/espsoftwareserial) library and examples written by Peter Lerup. Distributed under LGPL 2.1.
142142

0 commit comments

Comments
 (0)