From 3ee0d9a0b049444d5c0e2ae971909fadfc2d1016 Mon Sep 17 00:00:00 2001 From: Donovan Glover Date: Sun, 18 Nov 2018 17:06:18 -0500 Subject: [PATCH] docs: Add READMEs for ncmpcpp, ranger, and rofi --- ncmpcpp/README.md | 18 ++++++++++++++++++ ranger/README.md | 17 +++++++++++++++++ rofi/README.md | 17 +++++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 ncmpcpp/README.md create mode 100644 ranger/README.md create mode 100644 rofi/README.md diff --git a/ncmpcpp/README.md b/ncmpcpp/README.md new file mode 100644 index 00000000..426d7a9e --- /dev/null +++ b/ncmpcpp/README.md @@ -0,0 +1,18 @@ +# ncmpcpp + +[ncmpcpp][ncmpcpp] is a music player client for the terminal. + +## Use Cases + +ncmpcpp can be used to: + +- Manage your entire music library from a pretty terminal interface +- Let your music player have a color scheme consistent to your setup +- Add music functionality in your rice screenshot + +You should not use ncmpcpp if: + +- You use a desktop environment that already has a music player +- You do not want to use mpd + +[ncmpcpp]: https://github.com/arybczak/ncmpcpp diff --git a/ranger/README.md b/ranger/README.md new file mode 100644 index 00000000..fa191faf --- /dev/null +++ b/ranger/README.md @@ -0,0 +1,17 @@ +# ranger + +[ranger][ranger] is a file browser for the terminal with image support. + +## Use Cases + +ranger can be used to: + +- Easily see all filenames in directories as you browse through them +- Show image previews in the terminal (with [kitty](/kitty)) +- Use a file browser even through a tty + +You should not use ranger if: + +- You should use ranger. + +[ranger]: https://github.com/ranger/ranger diff --git a/rofi/README.md b/rofi/README.md new file mode 100644 index 00000000..99d4435e --- /dev/null +++ b/rofi/README.md @@ -0,0 +1,17 @@ +# rofi + +[rofi][rofi] is an application launcher, window switcher, and dmenu replacement. + +## Use Cases + +rofi can be used to: + +- Launch applications based on `.desktop` files +- Show all open windows and switch between them +- Parse dmenu-like input + +You should not use rofi if: + +- Your desktop environment already has an application launcher and window switcher + +[rofi]: https://github.com/DaveDavenport/rofi