Upload README.md

README.md

@@ -1,3 +1,33 @@
----
-license: other
----
+# w1-speech-recognition
+## Prerequisites
+* libsndfile
+
+`brew install libsndfile`
+
+* python 3
+
+`brew install python`
+
+## Prepare local environment
+In project root directory:
+
+Create virtual environment:
+
+`python3 -m venv venv`
+
+Activate it:
+
+`source venv/bin/activate`
+
+
+## Run flask app:
+```bash
+./run.sh
+```
+
+You can access the app on localhost:5000.
+
+## Test the endpoint
+Only **.wav** files are supported.
+
+You can find a sample file in test_files directory.