From: Andrew Gundersen <53452154+gundersena@users.noreply.github.com>
Date: Mon, 17 Feb 2020 23:17:11 +0000 (-0600)
Subject: Update README.md
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=cf19c6c86a87e28ca7ebab75ac6f041fd8cb130d;p=ml-audio-enhancer

Update README.md
---

diff --git a/README.md b/README.md
index 2cc2ac9..8d00c3a 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,15 @@
 Takes cruddy conference call audio and upsamples it to HD Audio
 
 To read more about the research, visit https://crimata.com/AIPost
+
+## Usage
+
+Repository Structure
+
+* `./data`: the data and the metadata (you should not need to touch this folder)
+* `./main`: the model and its respective utilites
+* `./samples`: audio files and spectrograms generated from the neural net
+
+```
+python 3 main.py -h
+```