You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,9 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
28
28
29
29
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).
30
30
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.
34
34
- 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).
- 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).
45
45
- Go to Arduino directory
46
46
- For Mac OS X, it is `Arduino.app` showing as the Arduino icon.
47
47
This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
@@ -71,7 +71,7 @@ python get.py
71
71
### Using PlatformIO
72
72
73
73
[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
75
75
for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows,
76
76
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
77
77
@@ -95,7 +95,7 @@ Documentation for latest development version: https://arduino-esp8266.readthedoc
95
95
96
96
### Issues and support ###
97
97
98
-
[ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a wellestablished community forquestions 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 hostedin 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 forquestions 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 hostedin this repo, or just want to discuss how to approach a problem, please ask there.
99
99
100
100
If you find the forum useful, please consider supporting it with a donation. <br />
@@ -106,7 +106,7 @@ Please provide as much context as possible, as well as the information requested
106
106
107
107
- ESP8266 Arduino core version which you are using (you can check it in Boards Manager)
108
108
- 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.
110
110
- forissues which happen at compile time, enable verbose compiler outputin the IDE preferences, and attach that output (also inside a code block)
111
111
- ESP8266 development board model
112
112
- IDE settings (board choice, flash size)
@@ -116,7 +116,7 @@ Please provide as much context as possible, as well as the information requested
116
116
117
117
For minor fixes of code and documentation, please go ahead and submit a pull request.
118
118
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.
120
120
121
121
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.
122
122
@@ -134,9 +134,9 @@ Espressif SDK included in this build is under Espressif MIT License.
134
134
135
135
ESP8266 core files are licensed under LGPL.
136
136
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.
138
138
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.
140
140
141
141
[SoftwareSerial](https://github.com/plerup/espsoftwareserial) library and examples written by Peter Lerup. Distributed under LGPL 2.1.
0 commit comments