From 419ea34c59e18ca052f5f4482451ab4ad6710a45 Mon Sep 17 00:00:00 2001 From: Audrey Roy Greenfeld Date: Tue, 10 Oct 2023 14:47:14 +0100 Subject: [PATCH] Document how to transcribe an mp3 file --- docs/getting_started.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting_started.md b/docs/getting_started.md index 13d5714..3aae4c1 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -68,3 +68,11 @@ Once you've installed the project, you can run the command-line interface with: │ transcribe "Transcribes an audio file into text. ╰──────────────────────────────────────────────────────────────────────── ``` + +To transcribe an mp3 file you would type: + +``` +hist transcribe data/2023-10-06_Mat.mp3 data/ +``` + +Once it's done, the transcript will be saved in data/ with the same name but a `.txt` extension.