search

pschatzmann / arduino-audio-tools

Arduino Audio Tools (a powerful Audio library not only for Arduino)
GNU General Public License v3.0
1.54k stars 237 forks source link

Update README.md #1551

Closed nebbian closed 6 months ago

nebbian commented 6 months ago

This change resolves an issue where new users would receive an error when first trying to compile some example code. The error they would receive is similar to this one: fatal error: AudioBoard.h: No such file or directory 2 | #include "AudioBoard.h"

This change ensures that new users will install the correct library.

pschatzmann commented 6 months ago

I am afraid you are mistaken. The instruction is for installing the audio tools! The audio-dirver library is just one of the many optional libraries

nebbian commented 6 months ago

Well, I might be mistaken. I was following the instructions here: https://github.com/pschatzmann/arduino-audio-tools and I got that error. I ran this command: git clone https://github.com/pschatzmann/arduino-audio-driver.git and the error went away, allowing me to compile your examples.

I'm just trying to help some other people who are very new to this library. I hope they find this post using google, if you aren't keen on merging this pull request.

pschatzmann commented 6 months ago

arduino-audio-driver is only needed if you use a Codec chip that needs to be configured via I2C. This is the case if you have e.g. an AI Thinker AudioTools board or a LyraT board.

I suggest that you read the Wiki before using this library