path: root/README.md

# musikbox
A custom music player for the command line, written in Rust.

# Installation
Install the run-time dependencies: `gstreamer gstreamer-vaapi gst-plugins-bad`.
Then, simply build the project using cargo.

This crate is currently not available on crates.io.