Merge pull request #30 from LimaoC/mitch-interim-docs

docs: added docs for data module and library overview in README
LimaoC · Aug 20, 2024 · 5253afa · 5253afa
2 parents 7aa3853 + b6c18db
commit 5253afa
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,13 @@
 # Sitting Desktop Garden
+## Library Overview
+```
+.
+├── client
+│   ├── data: Data handling for sitting-desktop-garden. Includes user, posture and face id data.
+│   └── models: Machine learning models (pose detection and face recognition).
+├── docs: Project documentation.
+├── notebooks: Demos for module use.
+```
 
 ## Installation
 **Important**: Make sure you have Python 3.10+ installed.

diff --git a/client/data/__init__.py b/client/data/__init__.py
@@ -0,0 +1 @@
+"""Data handling for sitting-desktop-garden. Includes user, posture and face id data."""
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		"""Data handling for sitting-desktop-garden. Includes user, posture and face id data."""