Skip to content

Commit 5af402e

Browse files
authored
Update README.md (esp8266#6624)
Replace latest git instructions in the README with a pointer to the instructions in readthedocs
1 parent d3debb6 commit 5af402e

File tree

1 file changed

+5
-27
lines changed

1 file changed

+5
-27
lines changed

README.md

+5-27
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
1616
# Contents
1717
- Installing options:
1818
- [Using Boards Manager](#installing-with-boards-manager)
19-
- [Using git version](#using-git-version-basic-instructions)
19+
- [Using git version](#using-git-version)
2020
- [Using PlatformIO](#using-platformio)
2121
- [Building with make](#building-with-make)
2222
- [Documentation](#documentation)
@@ -38,35 +38,13 @@ Boards manager link: `https://arduino.esp8266.com/stable/package_esp8266com_inde
3838

3939
Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.2/](https://arduino-esp8266.readthedocs.io/en/2.5.2/)
4040

41-
### Using git version (basic instructions)
41+
### Using git version
4242
[![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
4343

44+
Also known as latest git or master branch.
45+
4446
- 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-
- Go to Arduino directory
46-
- For Mac OS X, it is `Arduino.app` showing as the Arduino icon.
47-
This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
48-
```bash
49-
cd <application-directory>/Arduino.app/Contents/Java
50-
```
51-
- For Linux, it is ~/Arduino by default.
52-
```bash
53-
cd ~/Arduino
54-
```
55-
- Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
56-
```bash
57-
cd hardware
58-
mkdir esp8266com
59-
cd esp8266com
60-
git clone https://github.com/esp8266/Arduino.git esp8266
61-
cd esp8266
62-
git submodule update --init
63-
```
64-
- Download binary tools (you need Python 2.7)
65-
```bash
66-
cd esp8266/tools
67-
python get.py
68-
```
69-
- Restart Arduino
47+
- Follow the [instructions in the documentation](https://arduino-esp8266.readthedocs.io/en/latest/installing.html#using-git-version).
7048

7149
### Using PlatformIO
7250

0 commit comments

Comments
 (0)