INIT add readme

ShMcK · ShMcK · commit 72970c033fbe · 2020-06-14T11:55:58.000-07:00
diff --git a/README.md b/README.md
@@ -0,0 +1,47 @@
+# CodeRoad Python Unittest Starter
+
+A demo for running Python projects in CodeRoad.
+
+### Setup
+
+
+##### Virtual Environment
+
+Code runs inside of a virtual environment.
+
+On Windows, run:
+
+```shell
+tutorial-env\Scripts\activate.bat
+```
+
+On Unix or MacOS, run:
+
+```shell
+source tutorial-env/bin/activate
+```
+
+See [python venv](https://docs.python.org/3/tutorial/venv.html) docs for more.
+
+##### Install Dependencies
+
+Enter the code directory
+
+```shell
+cd coderoad-starter
+```
+
+Install dependencies
+
+```shell
+pip install requirements.txt
+```
+
+##### Run Tests
+
+To run tests, run:
+
+```shell
+python tests
+```
+
