Skip to content

Commit 410ab2d

Browse files
authored
Merge pull request #9 from baldram/DEV-1
Reword the description for cleaner understanding
2 parents dd6fba4 + 4d83078 commit 410ab2d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,18 @@ The library may be a base to build your own webradio player or different audio d
88

99
Designed specifically to work with the **Espressif ESP8266** and **ESP32** boards.
1010

11-
There are currently two methods to program the ESP boards: the ESP-IDF and the ESP8266/ESP32 arduino Core.
11+
Don't hesitate to create issues or pull requests if you want to improve ESP_VS1053_Library!
12+
13+
## Introduction
14+
15+
#### How to use the library?
16+
17+
There are currently two official methods to program the ESP boards: the ESP-IDF and the ESP8266/ESP32 arduino Core.
1218
The library was created to work with the **arduino Core**.
1319

1420
The ESP8266 is the most popular Wi-Fi MCU (known also as ESP12, NodeMCU, WeMos, ...).
1521

16-
Why PlatformIO?
22+
#### Why PlatformIO?
1723

1824
As mentioned in first paragraph, the library was prepared to be used with PlatformIO, which is kind of dependency management tool. It is highly recommended environment to be used while developing your electronics/IoT projects. The build automation lets you deal much easier while working with the project. It will help you to have all project dependencies simply resolved out of the box. What more, it provides very good IDE integration (any of popular), debugging possibility, remote unit testing and firmware updates. [Learn more about PlatformIO here](https://platformio.org/).
1925

0 commit comments

Comments
 (0)