From 6c4f4a7fc43d0dd6cddc653e7540ca388fdffb06 Mon Sep 17 00:00:00 2001 From: nc1z Date: Sat, 22 Jul 2023 15:02:00 +0800 Subject: [PATCH] docs: update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e4f089b..997edeb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# audio-extraction-tool +# Audio Extraction Tool Simple Python script to extract audio from videos + +## Getting started + +1. Make sure you have Python and Git installed on your computer +2. Clone the repository and navigate into the project root + ```bash + $ git clone https://github.com/nc1z/audio-extraction-tool.git + $ cd audio-extraction-tool/ + ``` +2. Run the command + + ```bash + $ pip install moviepy + ``` + +3. Place your mp4 videos into `./input` +4. Run the command + + ```bash + $ python main.py + ``` +5. The extracted audio files will be found in `./output` \ No newline at end of file