From 243deedb6099c3a88ca44a7e26e72bceb65f562e Mon Sep 17 00:00:00 2001
From: Terry Truong <terry06890@gmail.com>
Date: Mon, 3 Oct 2022 23:42:36 +1100
Subject: Add backend README

---
 backend/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 backend/README.md

diff --git a/backend/README.md b/backend/README.md
new file mode 100644
index 0000000..a818b42
--- /dev/null
+++ b/backend/README.md
@@ -0,0 +1,8 @@
+# Files
+-   `hist_data/`: Holds scripts for generating the history database and images
+-   `tests/`: Holds unit testing scripts <br>
+    Running all tests: `python -m unittest discover -s tests` <br>
+    Running a particular test: `python -m unittest tests/test_script1.py` <br>
+    Getting code coverage info (uses python package 'coverage'): <br>
+    1. `coverage run -m unittest discover -s tests`
+    2. `coverage report -m > report.txt`
-- 
cgit v1.2.3