Merge pull request #55 from slashml/youtube-transcription-docs

eff-kay · web-flow · commit 831f0e83af0d · 2023-07-03T19:01:28.000-04:00
add readme docs
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,16 @@
+Create a new venv, and install the requirements file
+
+
+Then run the following to compile the docs
+
+
+```bash
+make dirhtml
+```
+
+you can verify the updates by running the following command
+
+```bash
+python -m http.server --directory _build/dirhtml
+```
+
