summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorzlago2025-02-11 13:36:04 +0100
committerzlago2025-02-11 13:36:04 +0100
commitc3579a3f8784ad49d081dc8347bbcadacc0829a2 (patch)
tree1a2a91daaac17d95484f092f81cf5c4d0ebb1269 /README.md
parent4efa9f571e84cda3741e524fb21a3a22cdbc13fb (diff)
add support for organya (.org) modules
by porting https://github.com/alula/organya-js/ to c
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index b52d774..9d00e08 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,20 @@ play a song on loop
## rationale
i despise audio players that do not loop tracks correctly, since i always listen to a single song on loop
+
+## compiling
+
+you will need the following to compile mu
+
+- portaudio
+- sdl2
+- libopenmpt
+- libfluidsynth
+- a c compiler supporting `#embed`
+
+just run `make` and the binaries `mu-portaudio` and `mu-SDL2` should be in `out/`
+
+## licenses
+
+- the organya player code is a c port of [organya-js](https://github.com/alula/organya-js) which is licensed under the [3-clause BSD license](https://github.com/alula/organya-js/blob/master/LICENSE)
+- everything else in this repository was written by me ([~sylvie on tilde.town](https://tilde.town/~sylvie))