add Documentation

Author: frett27

CHANGELOG.md

@@ -0,0 +1,35 @@
+# ChangeLog
+
+*Patrice Freydiere - Avril 2020*
+
+
+
+## **Version 0.2 :**
+
+<u>Using the synthetizer in External Lib and Java Wrapper</u>
+
+The library has been integrated in external software using C api, using the **Ada-Synthetizer-Lib** project. For this purpose, a java wrapper has been setted up to ease the reuse on Java. See documentation
+
+
+
+**Ada Midi Player** has been added to demonstrate the use of the library, in a command line. Several options are available :
+
+```
+Ada-Midi-Player>main --help
+Usage: main.exe [switches] [arguments]
+
+ -f ARG         Specify the midi file to read
+ -t ARG         Tempo factor
+ -b, --bank=ARG instrument filename
+ -w ARG         Output to Wav File
+ --tempo=ARG    Enable long option. Arg is an integer
+ --help         Display help
+```
+
+The Midi Player is very limited, and is able to play a midi (merging all tracks, using a single recorded instrument). You can pass the -b option to use the **instrumentbundle** instrument file.
+
+
+
+**APrint Studio Soundbank reading from Ada** 
+
+This sub project is more related to Barrel Organ Discovery, but a reading of its sound bank has been setted up to use recorded instruments in playing.

README.md

@@ -1,6 +1,6 @@
 # Ada-Synthetizer Suite
 
-*Patrice Freydiere - December 2019*
+*Patrice Freydiere - April 2020*
 
 This **repository** provides a **synthetizer library implementation** for making music from samples (.wav files). A similar larger project is for example : timidity, fluidsynth. This library has been setted up to be able to handle Highly Polyphonic rendering. 
 
@@ -61,15 +61,17 @@ Can be extended outside the library, depending on needs. Theses drivers show how
 
 ### Supported Plateforms
 
-The Synthetizer has been tested on x64, x32 desktop computers.
+The Synthetizer has been tested on x64, x32 desktop computers (linux, windows, arm v6/v7)
+
+It also works well on ARM based processor (RPI/Orangepi)
+
 
-It also works well on ARM based processor, 
 
 
 
 ## Using the Synthetizer by example : the code
 
-Below, an example of the 5 mins , RealTime use of the synthetizer :
+Below, an example of the 5 mins , **RealTime** use of the synthetizer :
 
 
 
@@ -127,7 +129,7 @@ end;
 
 ```
 
-More information about the API and internals can be found in the link below, especially for version v0.1.5, where a ahead of time complementary API is provided.
+More information about the API and internals can be found in the link below, especially for version v0.1.5, where a ahead of time complementary API is provided. 
 
 [Additional technical insights can be found at this location](Ada-Synthetizer/doc/architecture.md)
 
@@ -139,28 +141,13 @@ The synthetizer behave nicely, there are no large amount or synchro between comp
 
 
 
-## Next actions
-
-Version 0.1.1 - **DONE**
-
-- ~~Fix Memory Leak for Win32 driver~~
-- ~~Eval portaudio for output rendering (X Plateform sound toolkit)~~
-- ~~Add Alsa Driver for linux plateforms~~
-- ~~Add Wav Driver for debugging purpose or to disk exports~~
-
-Version 0.1.2 - **DONE**
-
-- ~~x64 support, opening to x64 compatible library~~
-
-Version 0.1.5 - **DONE**
+## Version changes
 
-- ~~Ahead of time playin~~
+The current version is 1.2, see [ChangeLog][ChangeLog.md] for more informations about updates, and current improvments.
 
-Version 0.2:  - **In Progress**
 
-- ~~Interfaçing with C, Java for consuming the library~~ - first version included in Ada-Synthetizer-Lib Folder
 
-- ~~Ada-Midi-Player, using the synthetizer playin from Midi Files~~
+## Next actions
 
 Version 0.3
 
@@ -171,6 +158,7 @@ Mid Term Version, may be a rewrite targeting smaller footprint architectures:
 - Porting to Spark profile, remove the task part for embedded usage
 
 
+
 ### Areas That can be covered next (if time permit)
 
-FM generators : The current buffers are filled with Wav samples, but a short abstraction can be done to introduce signal generators and modulators to extends the use to "analog like" synthetizers.
+Oscillators / FM generators : The current buffers are filled with Wav samples, but a short abstraction can be done to introduce signal generators and modulators to extends the use to "analog like" synthetizers.