From d3537e656e87c011d8ee92ac623440c9f86da29b Mon Sep 17 00:00:00 2001 From: Donovan Glover Date: Sun, 18 Nov 2018 14:31:54 -0500 Subject: [PATCH] docs: Add READMEs for mpd, mpv, and sxhkd Contrary to the similarity in naming, mpd and mpv are two completely different programs that both serve completely different purposes. --- mpd/README.md | 15 +++++++++++++++ mpv/README.md | 18 ++++++++++++++++++ sxhkd/README.md | 16 ++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 mpd/README.md create mode 100644 mpv/README.md create mode 100644 sxhkd/README.md diff --git a/mpd/README.md b/mpd/README.md new file mode 100644 index 00000000..d3a17d56 --- /dev/null +++ b/mpd/README.md @@ -0,0 +1,15 @@ +# mpd + +[mpd][mpd] is a music player daemon. + +## Use Cases + +mpd can be used to: + +- Manage music independently of which client is being used + +You should not use mpd if: + +- The music player you use does not rely on mpd + +[mpd]: https://github.com/MusicPlayerDaemon/MPD diff --git a/mpv/README.md b/mpv/README.md new file mode 100644 index 00000000..f002ea73 --- /dev/null +++ b/mpv/README.md @@ -0,0 +1,18 @@ +# mpv + +[mpv][mpv] is a media player without a GUI. + +## Use Cases + +mpv can be used to: + +- Play every video format you encounter +- Work behind the scenes for larger GUI programs +- Watch videos with other tiled windows open and without GUI buttons taking up space +- Strategically position GUI-less videos in your rice screenshots + +You should not use mpv if: + +- You use a desktop environment with a media player + +[mpv]: https://github.com/mpv-player/mpv diff --git a/sxhkd/README.md b/sxhkd/README.md new file mode 100644 index 00000000..61b89923 --- /dev/null +++ b/sxhkd/README.md @@ -0,0 +1,16 @@ +# sxhkd + +[sxhkd][sxhkd] is a hotkey daemon for X11. + +## Use Cases + +sxhkd can be used to: + +- Bind any key combination to whatever shell command you want +- Control windows in [bspwm](/bspwm) through `bspc` + +You should not use sxhkd if: + +- You use a desktop environment that sets keybinds for you + +[sxhkd]: https://github.com/baskerville/sxhkd