docs: Add READMEs for bspwm and extras

Now that all the READMEs have been added, all that's left is to polish
them as time goes on. It may be useful to add images to each of the
package directories to show visually what each contain.
This commit is contained in:
Donovan Glover 2018-10-23 22:12:48 -04:00
parent 19b91ec9ce
commit 21814cda7f
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
2 changed files with 70 additions and 0 deletions

35
bspwm/README.md Normal file
View File

@ -0,0 +1,35 @@
# bspwm
I use `bspwm` as my window manager of choice. My setup is optimized for HiDPI, so you will have to manually adjust the numbers if you aren't using a HiDPI display.
## Dependencies
- [bspwm][bspwm] - Window manager
- [polybar][polybar] - Panel
- [dunst][dunst] - Notifications
- [rofi][rofi] - Window switcher, application launcher, and dmenu replacement
- [sxhkd][sxhkd] - Keybinds
- [rxvt-unicode-patched][rxvt-unicode-patched] - Terminal for image support
- [termite][termite] - Terminal for transparency and everything else
- [python-pywal][python-pywal] - A universal color scheme changer
- [feh][feh] - Used to set the background image
## Installation
```sh
make package=bspwm
```
## Usage
Either `startx` directly or use a display manager. Assuming you have the necessary dependencies installed, and assuming you configured your system properly, everything should just work.
[bspwm]: https://www.archlinux.org/packages/community/x86_64/bspwm/
[polybar]: https://aur.archlinux.org/packages/polybar/
[dunst]: https://www.archlinux.org/packages/community/x86_64/dunst/
[rofi]: https://www.archlinux.org/packages/community/x86_64/rofi/
[sxhkd]: https://www.archlinux.org/packages/community/x86_64/sxhkd/
[termite]: https://www.archlinux.org/packages/community/x86_64/termite/
[rxvt-unicode-patched]: https://aur.archlinux.org/packages/rxvt-unicode-patched/
[python-pywal]: https://www.archlinux.org/packages/community/any/python-pywal/
[feh]: https://www.archlinux.org/packages/extra/x86_64/feh/

35
extras/README.md Normal file
View File

@ -0,0 +1,35 @@
# Extras
Some other programs I use that have dotfiles.
## Dependencies
- [httpie][httpie] - A friendly version of curl / wget
- [feh][feh] - A GUI-less image viewer
- [mpd][mpd] - The music player daemon
- [ncmpcpp][ncmpcppp] - A stylish music player client for the terminal
- [youtube-dl][youtube-dl] - A program that can download online videos
- [ranger][range] - A file explorer with image preview support for the terminal
- [rtv][rtv] - A reddit browser for the terminal
- [yay][yay] - An AUR helper for Arch Linux
- [mpv][mpv] - A media player without the GUI
## Installation
```sh
make package=extras
```
## Usage
Use these programs like you normally would, and the settings will be automatically applied.
[httpie]: https://www.archlinux.org/packages/community/any/httpie/
[feh]: https://www.archlinux.org/packages/extra/x86_64/feh/
[mpd]: https://www.archlinux.org/packages/extra/x86_64/mpd/
[ncmpcpp]: https://www.archlinux.org/packages/community/x86_64/ncmpcpp/
[youtube-dl]: https://www.archlinux.org/packages/community/any/youtube-dl/
[ranger]: https://www.archlinux.org/packages/community/any/ranger/
[rtv]: https://aur.archlinux.org/packages/rtv
[yay]: https://aur.archlinux.org/packages/yay
[mpv]: https://www.archlinux.org/packages/community/x86_64/mpv/