Cleanup Readme

Author: pschatzmann

README.md

@@ -13,6 +13,7 @@ Some basic __header-only C++ classes__ that can be used for __Audio Processing__
 - TimerAlarmRepeating (e.g. for sampling audio data using exact times) [ESP32 only]
 - A Wav Encoder and Decoder
 - AudioOutputWithCallback class to provide callback integration e.g. with ESP8266Audio
+- Building of Arduino Audio Sketches to be run on [Linux, Windows and OS/X](https://github.com/pschatzmann/arduino-audio-tools/wiki/Running-an-Audio-Sketch-on-the-Desktop)
 
 This functionality provides the glue which makes different audio processing components and libraries work together.
 We also provide plenty of examples that demonstrate how to implement the different scenarios. The __design philosophy__ is based on the Arduino conventions: we use the ```begin()``` and ```end()``` methods to start and stop the processing and we propagate the __use of Streams__.  We all know the [Arduino Streams](https://pschatzmann.github.io/arduino-audio-tools/html/class_stream.html): We usually use them to write out print messages and sometimes we use them to read the output from Serial devices. The same thing applies to “Audio Streams”: You can read audio data from “Audio Sources” and you write them to “Audio Sinks”.
@@ -71,66 +72,12 @@ void loop(){
 ```
 A complete list of the supported Audio Stream classes and scenarios can be found in the [Scenarios Document](Scenarios.md)
 
-### Sound Output
+### Examples
 
-- __I2SStream__: The best quality can be achieved with the help of I2S and an external DAC.  I2S is supporting 2 channels only. 
-- __AnalogAudioStream__: Some processors are providing an analog output, this is usually an easy and good approach: The number of pins (and herewith output channels) however is usually very limited.
-- __PWMAudioStream__: The last possibility is to simulate an analog output with the help of PWM by using a frequency which is beyond the audible range of 20 KHz. This method is supported by all processors and usually supports a bigger number of output pins. In terms of audio quality this is usually the worst option.
+Further examples can be found in the [wiki](https://github.com/pschatzmann/arduino-audio-tools/wiki/Examples)!
 
 
-## Examples
-
-The examples follow the following naming convention: "scenario type"-"source"-"destination". For the scenario types we might have __base__ (using basic api functionality), __stream__ for examples using Streams and __test__ for the test cases. 
-
-For the __source__ we currently have __adc__ for analog input devices like analog microphones, __i2s__ for digital input devices (e.g. digital microphones), __file__ for SD files and __a2dp__ for input from Bluetooth A2DP (e.g. from a Mobile Phone).
-
-For the __destination__ we use __dac__ for analog output (e.g. to an amplifier), __i2s__ for digital output devices (e.g. an external DAC), __file__ for SD files and __a2dp__ for output to Bluetooth A2DP (e.g. a Bluetooth Speaker).
-
-
-Here is the list of examples:
-
-#### Stream API
-
-Here are a couple of simple test sketches to demo different output destinations:
-
-- [streams-generator-serial](examples/streams-generator-serial) Displaying generated sound on the Serial Plotter
-- [streams-generator-i2s](examples/streams-generator-i2s) Output of generated sound on external DAC via I2S
-- [streams-generator-dac](examples/streams-generator-dac) Output of generated sound on ESP32 internal DAC via I2S
-- [streams-generator-a2dp](examples/streams-generator-a2dp) Output of generated sound on Bluetooth Speaker using A2DP
-- [streams-generator-pwm](examples/streams-generator-pwm) Output of generated sound with PWM
-- [streams-adc-serial](examples/streams-adc-serial) Displaying input from analog microphone on the Serial Plotter
-- [streams-memory_wav-serial](examples/streams-memory_wav-serial) Decoding of WAV from Flash memory and display on the Serial Plotter
-
-And some more useful examples:
-
-- [streams-memory_raw-i2s](examples/streams-memory_raw-i2s) - Play music form Flash Memory via I2S to External DAC
-- [streams-url_raw-serial](examples/streams-url_raw-serial) Displaying a music file from the internet on the Serial Plotter
-- [streams-url_raw-I2S.ino](examples/streams-url_raw-i2s) Streaming a File from the Internet to on external DAC via I2S
-- [streams-url_wav-i2s](examples/streams-url_wav-i2s) Text to Speach example using Rhasspy
-
-... these are just a few examples, but you can combine any Input Stream with any Output Stream as you like...
-
-#### Basic API
-
-- [base-adc-serial](basic-api/base-adc-serial) - Sample analog sound and write it to Serial
-- [base-adc-a2dp](basic-api/base-adc-a2dp) - Sample analog sound and write it to a A2DP Bluetooth source 
-- [base-file_raw-serial](basic-api/base-file_raw-serial) - Read Raw File from SD card to and write it to Serial
-- [base-file_raw-a2dp](basic-api/base-file_raw-a2dp) - Read Raw File from SD card write it A2DP Bluetooth
-- [base-file_mp3-a2dp](basic-api/base-file_mp3-a2dp) - Stream MP3 File from SD card to A2DP Bluetooth using the ESP8266Audio library
-- [base-i2s-serial](basic-api/base-i2s-serial) - Sample digital sound and write it to Serial
-- [base-i2s-a2dp](basic-api/base-i2s-a2dp) - Sample analog sound and write it to a A2DP Bluetooth source 
-
-#### Listening to the Result with a Webbrowser
-
-I am also providing a simple webserver which can render the audio data as wav result. 
-Here are some examples:
-
-- [streams-generator-webserver_wav](examples/streams-generator-webserver_wav) A Webserver which renders some generated sound
-- [streams-sam-webserver_wav](examples/streams-sam-webserver_wav) A Webserver which renders the result from the SAM TTS engine
-- [streams-tts-webserver_wav](examples/streams-tts-webserver_wav) A Webserver which renders the result from the Arduino TTS engine
-- [streams-flite-webserver_wav](examples/streams-flite-webserver_wav) A Webserver which renders the result from the Flite TTS engine
-
-#### Logging
+### Logging
 
 The application uses a built in logger (see AudioLogger.h and AudioConfig.h). You can  e.g. deactivate the logging by changing USE_AUDIO_LOGGING to false in the AudioConfig.h: 
 
@@ -146,8 +93,7 @@ Per default we use the log level warning and the logging output is going to Seri
 AudioLogger::instance().begin(Serial, AudioLogger::Debug);
 ```
 
-
-## Optional Libraries
+### Optional Libraries
 
 Dependent on the example you might need to install some of the following libraries:
 
@@ -160,34 +106,20 @@ Dependent on the example you might need to install some of the following librari
 - [TTS](https://github.com/pschatzmann/TTS) A Text to Speach Engine
 - [flite](https://github.com/pschatzmann/arduino-flite) A Text to Speach Engine
 
-## Installation
-
-You can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with
-
-```
-cd  ~/Documents/Arduino/libraries
-git clone pschatzmann/arduino-audio-tools.git
-
-```
 
-## Documentation
+### Documentation
 
 Here is the generated [Class documentation](https://pschatzmann.github.io/arduino-audio-tools/html/annotated.html). 
 
 You also might find further information in [one of my blogs](https://www.pschatzmann.ch/home/category/machine-sound/)
 
-## Project Status
 
-This is currently work in progress:
+### Installation
+
+You can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with
 
-| Functionality          | Status  |
-|------------------------|---------|
-| Analog input - ADC     | tested  |
-| I2S                    | tested  |
-| PWM Output             | tested  |
-| Files (RAW, MP3...)    | tested  |
-| Streams                | tested  |
-| WAV encoding/deconding | tested  |          
-| AAC encoding/deconding | open    |          
-| int24_t                | tested  |           
+```
+cd  ~/Documents/Arduino/libraries
+git clone pschatzmann/arduino-audio-tools.git
 
+```