From fc5789e026473ea82237be847672ecb350e64479 Mon Sep 17 00:00:00 2001 From: tslil Date: Tue, 14 Jul 2026 20:22:56 +0100 Subject: license, simplify code, add README, lose "learner" naming --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..86fcab8 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# mood + +a music player governed by your moods. + +`mood` is designed for the following use case: run it and it will play something new to listen to based on your listening history. + +The way it does this is by measuring the time it took since the last time since it was run to classify itself as being invoked to "skip" or to produce "more", and then comparing your recent `mood` interactions against all of the other times you invoked `mood` to guess (hopefully well). + +For details on this algorithm, see `intuition.rs`. + +### requirements +- `mpc` +- `notify-send` +- rust / cargo + +### usage + +* build the code (`cargo build -r`) and put `mood` in your path +* to initialise a config, run `mood --new-config` and then edit `mood/mood.json` in your `XDG_CONFIG_DIR` (or look in `~/.config/mood`) +* it's suggested to bind `mood` (with no arguments) to some convenient key-press + +### license +GPL-3.0-or-later (see LICENCE) -- cgit v1.2.3