Add instructions for use with GIT 2.4+ only

This commit is contained in:
Earle F. Philhower, III committed 2017-12-15 14:44:56 -08:00
1 parent 8e94702468
commit 43273e3394
1 file changed
+9 -1
+9 -1
View File
@@ -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.