From 64c7ab5c2c14e76eba36fbcbc1c391aa349aea0b Mon Sep 17 00:00:00 2001 From: Christian Brickhouse Date: Wed, 13 Mar 2024 15:30:12 -0700 Subject: [PATCH] Add basic usage pattern to README See #96 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 9ba3b6a..daef6cc 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,22 @@ This is a repository for the FAVE-Align and FAVE-extract toolkits. The first commit here represents the toolkit as it was available on the FAVE website as of October 21, 2013. The extractFormants code in the JoFrhwld/FAAV repository represents an earlier version of the code. +## Getting started + +You can install FAVE using pip by running the following: +``` +python3 -m pip install fave +``` + +While FAVE can align transcripts to audio data, we recommend using the [https://montreal-forced-aligner.readthedocs.io/en/latest/first_steps/index.html#first-steps-align-pretrained](Montreal Force Aligner) for alignment because it is more recent and better maintained than the HTK library used by FAVE's aligner. + +When you have an aligned TextGrid and the matching audio, you can extract acoustic measures by running the following: +``` +fave-extract AudioFileName.wav TextGridFileName.TextGrid OutputFileName +``` + +Where `AudioFileName.wav` is the path to the audio file to measure, `TextGridFileName.TextGrid` is the path to the aligned TextGrid, and `OutputFileName` is the name of the file where you want your measurements to be output. + ## Documentation Current documentation for installation and usage available on the github wiki. [https://github.com/JoFrhwld/FAVE/wiki](https://github.com/JoFrhwld/FAVE/wiki)