From 263d446d1dea59214771019b6182a7d44d39f5d8 Mon Sep 17 00:00:00 2001
From: Chris Fulljames <christianfulljames@gmail.com>
Date: Sun, 6 Apr 2025 16:19:06 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf9d68e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# little song place
+Have feedback or bug reports?  Open an new issue on the
+[issues page](https://github.com/cfulljames/littlesongplace/issues).
+
+## Code Overview
+This is a pretty simple [Flask](https://flask.palletsproject.com) app.  If
+you've used Flask before, hopefully it feels pretty familiar.
+
+The main python code is in [/src/littlesongplace](/src/littlesongplace).  The
+main Flask() app instance is in [__init__.py](/src/littlesongplace/__init__.py).
+
+HTML templates can be found in [/src/littlesongplace/templates](/src/littlesongplace/templates).
+
+Static files, including images, CSS, and Javascript are stored in [/src/littlesongplace/static](/src/littlesongplace/static).
+
+The tests in [/tests](/tests) can be run with pytest.
+
+## Dependencies
+This project has some dependencies that need to be installed manually to your system PATH:
+- [Python 3.11](https://python.org)
+- mpck from [Checkmate](https://github.com/Sjord/checkmate)
+- [ffmpeg](https://ffmpeg.org/)
+
+## Environment Setup
+In the cloned project directory, setup a Python environment and install the
+necessary dependencies:
+``` sh
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# macOS/Linux
+. .venv/bin/activate
+
+pip install -e .
+pip install -r dev-requirements.txt
+```
+
+## Running
+Run the app locally (accessible in a browser at localhost:5000):
+``` sh
+flask --app littlesongplace run --debug
+```
+
+## Testing
+Run the tests with Pytest:
+``` sh
+pytest
+```
-- 
2.39.5