From f3dabc1116c1687ef681031dc4b68648471b227a Mon Sep 17 00:00:00 2001 From: Kalzu Rekku Date: Sat, 25 Jan 2025 23:44:59 +0200 Subject: [PATCH] readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..97aec2c --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# EEE PC Alarm Clock! + +Runs on Debian 12. +Requires Python 3 and mpg123. + +To use, just run `main.py` from the `alert_api/` directory. + +It includes: +- A local ncurses UI. +- A simple HTTP API (for how to use it, check out `alert_api/tests.sh`). + +Put your alarm sounds in `~/alarms/` as MP3 files. + +License: MIT \ No newline at end of file