diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
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) |