Skip to content

Commit ce9e817

Browse files
authored
Add PlatformIO related information (#7)
Update documentation with PlatformIO related information
1 parent b70f7af commit ce9e817

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# VS1053 library
22

3-
This is a library for the generic **[VS1053 Breakout](http://www.vlsi.fi/en/products/vs1053.html)** by VLSI Solution.<br/>
3+
This is a PlatformIO library for the generic **[VS1053 Breakout](http://www.vlsi.fi/en/products/vs1053.html)** by VLSI Solution.<br/>
44
A powerful Ogg Vorbis / MP3 / AAC / WMA / FLAC / MIDI Audio Codec chip.<br/>
55
Read more: [http://www.vlsi.fi/en/products/vs1053.html](http://www.vlsi.fi/en/products/vs1053.html).
66

7-
The library is a great base to build your own webradio player.
7+
The library may be base to build your own webradio player or different audio device.
88

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

1111
There are currently two methods to program the ESP boards: the ESP-IDF and the ESP8266/ESP32 arduino Core.
1212
The library was created to work with the **arduino Core**.
13-
13+
1414
The ESP8266 is the most popular Wi-Fi MCU (known also as ESP12, NodeMCU, WeMos, ...).
1515

16+
Why PlatformIO?
17+
18+
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/).
19+
1620
## Usage
1721

1822
#### Configure and use the library

0 commit comments

Comments
 (0)