commit 09223daf13957e0fe22ace0f6a2f5a96f8b16344 from: Omar Polo date: Sat Jun 11 07:55:04 2022 UTC some tweaks for the readme commit - a130f0271c0a856e6104a3eec0a4101b4c75f5df commit + 09223daf13957e0fe22ace0f6a2f5a96f8b16344 blob - 99d292adbe302293dbdcd40328819e945628ca7a blob + 58e7d7094071fa47312698e7a54570289859c6ab --- README.md +++ README.md @@ -1,9 +1,9 @@ # amused -amused is a music player. It doesn't have any amazing functionalities -built-in, on the contrary: it's quite minimal (a fancy word to say that -does very little.) It composes well, or aims to do so, with other tools -thought. +amused is a music player. It doesn't have any amazing features +built-in, on the contrary: it's quite minimal (a fancy word to say +that does very little.) It composes well, or aims to do so, with +other tools thought. The main feature is that audio decoding runs in a sandboxed process under `pledge("stdio recvfd audio")`. Oh, by the way, amused targets @@ -15,25 +15,26 @@ providing shims for some non-portable functions -- hel assuming that sndio is available. And bundling a copy of imsg.c too) -## building +## Building $ make + $ make install # eventually -it needs the following packages from ports: +Release tarballs installs into `/usr/local/`, git checkouts installs +into `~/bin` (idea and implementation stolen from got, thanks stsp!) +It needs the following packages from ports: + - flac - libmpg123 - libvorbis - opusfile -Release tarballs installs into `/usr/local/`, git checkouts installs -into `~/bin` (idea and implementation stolen from got, thanks stsp!) +It's available on the OpenBSD port tree starting with 7.1 -It'll be available on OpenBSD starting with 7.1 +## Usage -## usage - The fine man page has all nitty gritty details, but the TL;DR is - enqueue music with `amused add files...` @@ -51,7 +52,7 @@ standard UNIX tools can be used: It also doesn't provide any means to manage a music collection. It plays nice with find(1) however: - find . -type f -iname \*.opus -exec amused add {} + + find . | amused load I wrote a bit more about the background of amused [in a blog post](https://www.omarpolo.com/post/amused.html).