Add Readme

jordanalwon · Feb 19, 2024 · c2e973f · c2e973f
1 parent fbc6832
commit c2e973f
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# .aup3-Converter
+*.aup3-Converter* extracts the data of an Audacity project file (.aup3) and makes it available for further processing or saves the data in more accessible file formats.
+
+.aup3-Converter is MIT licensed
+(c) 2024, Jordan Alwon
+
+## Installation
+*.aup3-Converter* depends on the Python packages NumPy and Soundfile.
+
+## Export Data
+```python
+from convert import Converter
+converter = Converter(path)
+converter.export_audio('export.wav')
+converter.export_label("export.txt")
+```