diff --git a/README.md b/README.md index c55c42a..3f4a88f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # DeepFormants Formant Tracking & Estimation +How to use: +For vowel formant estimation call the main script in a terminal with the wav file and the vowel begin and end times +Ex: $ python formants.py mywavfile.wav 2.45 2.78 + +For formant tracking just call the script with the wav file and it will return the formants for the whole file every 10 ms +Ex: $ python formants.py mywavfile.wav Installation instructions