docs: Add READMEs for bspwm, polybar, and rtv

This commit is contained in:
Donovan Glover 2018-11-18 15:20:14 -05:00
parent d3537e656e
commit 58f7581be9
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
3 changed files with 52 additions and 0 deletions

18
bspwm/README.md Normal file
View File

@ -0,0 +1,18 @@
# bspwm
[bspwm][bspwm] is a tiling window manager for X11.
## Use Cases
bspwm can be used to:
- Automatically tile all kinds of windows, maximizing screen estate
- Have complete control of your window manager through simple shell commands
- Minimize resource usage; bspwm works best without a desktop environment
You should not use bspwm if:
- You are using a desktop environment
- You just want to open multiple shells (use [kitty](/kitty) or [tmux](/tmux) for this instead)
[bspwm]: https://github.com/baskerville/bspwm

17
polybar/README.md Normal file
View File

@ -0,0 +1,17 @@
# polybar
[polybar][polybar] is an information panel for your desktop.
## Use Cases
polybar can be used to:
- Show the current desktop, empty desktops, and occupied desktops
- Show the date, time, volume, CPU statistics, and other information
- Show the current playing song or anything else you want
You should not use polybar if:
- You already use a desktop environment that has an information panel
[polybar]: https://github.com/jaagr/polybar

17
rtv/README.md Normal file
View File

@ -0,0 +1,17 @@
# rtv
[rtv][rtv] is a reddit browser for your terminal.
## Use Cases
rtv can be used to:
- Ignore busy images or other media and focus on the content
- Always have a reddit theme consistent with your setup
- Use reddit without leaving the terminal, even through ttys
You should not use rtv if:
- You don't use reddit
[rtv]: https://github.com/michael-lazar/rtv