From 0221958684b7585a6eb40a062f5083eb7ce20a7c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Gro=C3=9F?= <git@minzkraut.com>
Date: Fri, 8 Jul 2022 13:20:44 +0200
Subject: [PATCH] Update README and add default music dir

---
 .gitignore     |  2 ++
 README.md      | 21 +++++++++++++++++++++
 music/.gitkeep |  0
 3 files changed, 23 insertions(+)
 create mode 100644 music/.gitkeep

diff --git a/.gitignore b/.gitignore
index 90edb69..7f3863e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,6 @@
 test/*
+music/*
+!music/.gitkeep
 venv/*
 *.mp3
 *.flac
diff --git a/README.md b/README.md
index 797f176..6a3b311 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
 # CTTF
+
+Recursively looks for flac files within the current working directory  
+Extracts and saves cover.jpg  
+Transcodes to mp3 320kbps  
+Saves files according to the specified format string  
+Keeps original files in "processed"  
+
+## Usage
+Create new venv and install dependencies
+```
+$ python3 -m venv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt
+```
+
+Place music in `./music` or run the script within a directory that already holds music  
+run cttf.py 
+```
+$ ./cttf.py
+```
+
diff --git a/music/.gitkeep b/music/.gitkeep
new file mode 100644
index 0000000..e69de29