From 1ab9348a4c0eac4d8e42476a4cae8b08975dd626 Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Wed, 6 Dec 2017 14:07:06 -0800 Subject: [PATCH] Update the instructions for installation The library will not compile w/o the SPI driver, add it to the README. Point to my fork until @armSeb's pull request in the original is merged. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7717077..476a386 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ The AAC decode code is from the Helix project and licensed under RealNetwork's R MIDI decoding comes from a highly ported MIDITONES (https://github.com/LenShustek/miditones) combined with a massively memory-optimized TinySoundFont (https://github.com/schellingb/TinySoundFont), see the respective source files for more information. +## Installation +Install the library and the SPI driver library in your ~/Arduino/libraries +```` +mkdir -p ~/Arduino/libraries +cd ~/Arduino/libraries +git clone https://github.com/earlephilhower/ESP8266Audio +git clone https://github.com/earlephilhower/ESP8266_Spiram +# Once the pull request is merged, replace above with "git clone https://github.com/Gianbacchio/ESP8266_Spiram" +```` + ## Usage Create an AudioInputXXX source pointing to your input file, an AudioOutputXXX sink as either an I2SDAC, I2S-sw-DAC, or as a "SerialWAV" which simply writes a WAV file to the Serial port which can be dumped to a file on your development system, and an AudioGeneratorXXX to actually take that input and decode it and send to the output.