From 43273e3394846186451f37c65ee577bebea55c20 Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Fri, 15 Dec 2017 14:43:48 -0800 Subject: [PATCH] Add instructions for use with GIT 2.4+ only --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 476a386..f84245c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ 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 +## Prerequisites and Installation +First, make sure you are running the 2.4-rc2 or GIT head version of the Arduino libraries. See https://github.com/esp8266/Arduino/blob/master/README.md#using-git-version for detailed instructions. + Install the library and the SPI driver library in your ~/Arduino/libraries ```` mkdir -p ~/Arduino/libraries @@ -18,6 +20,12 @@ 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" ```` +When in the IDE please select the following options: +```` +Tools->lwIP Variant->v1.4 Open Source +Tools->CPU Frequency->160MHz +```` + ## 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.