From af269097e20933b933517c6af7b7e009a2b3e476 Mon Sep 17 00:00:00 2001 From: Chris Fulljames Date: Sun, 17 Aug 2025 11:16:14 -0400 Subject: [PATCH] Update README --- README.md | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f294dc3..efba6b4 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,43 @@ # little song place -test +Hello! You've found the source code for littlesong.place. Feel free to have a +look around. ## Code Overview -This is a pretty simple [Flask](https://flask.palletsproject.com) app. If +This is a pretty simple [Flask](https://flask.palletsprojects.com) app. If you've used Flask before, hopefully it feels pretty familiar. -Important Places: -- [`/src/littlesongplace`](/src/littlesongplace) - the main python code -- [`__init__.py`](/src/littlesongplace/__init__.py) - entry point; the main Flask() app instance -- [`/src/littlesongplace/templates`](/src/littlesongplace/templates) - HTML templates -- [`/src/littlesongplace/static`](/src/littlesongplace/static) - static files, including images, CSS, and Javascript -- [`/test`](/test) - tests, run with pytest +Here are some quick links if you just want to browse the code: + +- [`/src/littlesongplace`](gitweb.cgi?p=littlesongplace.git;a=tree;f=src/littlesongplace) - the main python code +- [`/src/littlesongplace/templates`](gitweb.cgi?p=littlesongplace.git;a=tree;f=src/littlesongplace/templates) - HTML templates +- [`/src/littlesongplace/static`](gitweb.cgi?p=littlesongplace.git;a=tree;f=src/littlesongplace/static) - static files, including images, CSS, and Javascript +- [`/test`](gitweb.cgi?p=littlesongplace.git;a=tree;f=test) - tests, 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) - [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 +`python -m venv .venv` + +`. .venv/bin/activate` (or `.venv\Scripts\activate` on Windows) -# macOS/Linux -. .venv/bin/activate +`pip install -e .` -pip install -e . -pip install -r dev-requirements.txt -``` +`pip install -r dev-requirements.txt` ## Running Run the app locally (accessible in a browser at localhost:5000): -``` sh -flask --app littlesongplace run --debug -``` + +`flask --app littlesongplace run --debug` ## Testing Run the tests with Pytest: -``` sh -pytest -``` + +`pytest` + -- 2.39.5