aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4cec9e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# EgoMetrics
+
+Personal metrics tracking tool. Currently tracks workout sessions.
+
+## Requirements
+
+- Python 3.10+
+- SQLite (bundled with Python)
+
+No external dependencies.
+
+## Usage
+
+```
+python3 egometrics.py
+```
+
+### Main menu
+
+1. **Log Workout** — pick exercises, enter sets/reps/RPE/rest time/Last Set RPE for each
+2. **View Sessions** — browse past sessions, view details, delete
+3. **Manage Exercises** — add, edit, list, delete exercises
+
+### Data
+
+All data is stored in `egometrics.db` (created on first run). Copy this file to use your data on another machine.