Init

README.md

@@ -0,0 +1,29 @@
+# How to run the completed project
+
+## Prerequisite
+The application has only been tested on Python 3.7.3 x86_64 on Windows. However, I don't see why it wouldn't work on *NIX as well.
+Note that Windows' default conhost terminal emulator may have problem displaying unicode characters. I personally run it in PyCharm CE or Visual Studio Code Terminal.
+
+1. Create a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) and activate it (optional / recommended)  
+    ```
+    python3 -m venv /path/to/new/venv
+    *NIX: source /path/to/new/venv/bin/activate
+    Windows: C:\path\to\new\env\Scripts\activate
+    ```
+
+1. Install dependencies requirements.
+    ```Shell
+    pip install -r requirements.txt
+    ```
+
+1. Navigate to `conf/` directory and make a copy of each `.sample.json` files renaming each to remove `.sample` (ie, rename the copy to `sync_settings.json`).  
+Edit those files to populate the correct values.
+
+## Run the code
+
+Run `main.py` in the terminal to start the application.
+
+## Development: Making changes
+
+When installing / updating dependencies, update requirements.txt  
+`pip freeze > requirements.txt`