Skip to content

Commit 5aa6b72

Browse files
author
blue-2357
committed
Format README contents; add instructions for @platformio (#88)
1 parent e6b8822 commit 5aa6b72

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

README.md

+30-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
Arduino core for ESP32 WiFi chip
2-
===========================================
1+
# Arduino core for ESP32 WiFi chip
32

4-
### Development Status
3+
- [Development Status](#development-status)
4+
- Installing options:
5+
+ [Using Arduino IDE](#using-arduino-ide)
6+
+ [Using PlatformIO](#using-platformio)
7+
+ [Using as ESP-IDF component](#using-as-esp-idf-component)
8+
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
9+
10+
## Development Status
511
Not everything is working yet, you can not get it through package manager, but you can give it a go and help us find bugs in the things that are implemented :)
612

713
The framework can also be downloaded as component in an IDF project and be used like that.
@@ -21,11 +27,11 @@ Things that work:
2127
WiFiClient, WiFiServer and WiFiUdp are not quite ready yet because there are still some small hiccups in LwIP to be overcome.
2228
You can try WiFiClient but you need to disconnect the client yourself to be sure that connection is closed.
2329

24-
### Installation
30+
## Using Arduino IDE
2531

26-
####[Instructions for Windows](doc/windows.md)
32+
###[Instructions for Windows](doc/windows.md)
2733

28-
#### Instructions for Mac
34+
### Instructions for Mac
2935
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
3036
- Open Terminal and execute the following command (copy->paste and hit enter):
3137

@@ -41,7 +47,7 @@ You can try WiFiClient but you need to disconnect the client yourself to be sure
4147
```
4248
- Restart Arduino IDE
4349

44-
#### Instructions for Debian/Ubuntu Linux
50+
### Instructions for Debian/Ubuntu Linux
4551
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
4652
- Open Terminal and execute the following command (copy->paste and hit enter):
4753

@@ -59,7 +65,21 @@ You can try WiFiClient but you need to disconnect the client yourself to be sure
5965
```
6066
- Restart Arduino IDE
6167

62-
#### Instructions for using as esp-idf component
68+
## Using PlatformIO
69+
70+
[PlatformIO](http://platformio.org) is an open source ecosystem for IoT
71+
development with cross platform build system, library manager and full support
72+
for Espressif ESP32 development. It works on the popular host OS: Mac OS X, Windows,
73+
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
74+
75+
- [What is PlatformIO?](http://docs.platformio.org/page/what-is-platformio.html)
76+
- [PlatformIO IDE](http://platformio.org/platformio-ide)
77+
- Quick Start with [PlatformIO IDE](http://docs.platformio.org/page/ide/atom.html#quick-start) or [PlatformIO Core](http://docs.platformio.org/page/core.html)
78+
- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/page/ide.html) -
79+
Cloud9, Codeanywehre, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM and Visual Studio
80+
- [Project Examples](https://github.com/platformio/platform-espressif32/tree/develop/examples)
81+
82+
## Using as ESP-IDF component
6383
- Download and install [esp-idf](https://github.com/espressif/esp-idf)
6484
- Create blank idf project (from one of the examples)
6585
- in the project folder, create a folder called components and clone this repository inside
@@ -112,4 +132,6 @@ You can try WiFiClient but you need to disconnect the client yourself to be sure
112132
- Else it will wait for WiFi.begin
113133
- ```make flash monitor``` will build, upload and open serial monitor to your board
114134

135+
## ESP32Dev Board PINMAP
136+
115137
![Pin Functions](doc/esp32_pinmap.png)

0 commit comments

Comments
 (0)