From 43e79e29142dc257505a5fe7eb5a45a09c0b8673 Mon Sep 17 00:00:00 2001 From: Donovan Glover Date: Tue, 23 Oct 2018 14:25:08 -0400 Subject: [PATCH] docs: Add READMEs for git, plasma, and tmux Whether or not Plasma-specific dotfiles are still needed is questionable, but I will keep this directory for now. --- git/README.md | 26 ++++++++++++++++++++++++++ plasma/README.md | 21 +++++++++++++++++++++ tmux/README.md | 21 +++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 git/README.md create mode 100644 plasma/README.md create mode 100644 tmux/README.md diff --git a/git/README.md b/git/README.md new file mode 100644 index 0000000..ee5d9f4 --- /dev/null +++ b/git/README.md @@ -0,0 +1,26 @@ +# Git + +I use git as my main tool for distributed version control. + +## Dependencies + +- [git][git] - The standard version control system + +## Installation + +```sh +make package=git +``` + +## Usage + +Add a `.gituser` file to your `$HOME` with the following: + +```gitconfig +[user] + name = + email = + signingkey = +``` + +[git]: https://www.archlinux.org/packages/extra/x86_64/git/ diff --git a/plasma/README.md b/plasma/README.md new file mode 100644 index 0000000..b6b0a57 --- /dev/null +++ b/plasma/README.md @@ -0,0 +1,21 @@ +# Plasma + +Here lies any dotfiles I use specifically for KDE Plasma (not just KDE). + +## Dependencies + +- [plasma-desktop][plasma-desktop] - The KDE Plasma desktop environment +- [python-pywal][python-pywal] - A universal color scheme changer + +## Installation + +```sh +make package=plasma +``` + +## Usage + +Start plasma as you normally would and your previous pywal settings will be automatically applied. + +[plasma-desktop]: https://www.archlinux.org/packages/extra/x86_64/plasma-desktop/ +[python-pywal]: https://www.archlinux.org/packages/community/any/python-pywal/ diff --git a/tmux/README.md b/tmux/README.md new file mode 100644 index 0000000..a96a03d --- /dev/null +++ b/tmux/README.md @@ -0,0 +1,21 @@ +# tmux + +I use tmux to run multiple shells inside a single terminal, in addition to all the other benefits that tmux provides, such as session management, persistent history, and detaching. + +## Dependencies + +- [tmux][tmux] - Terminal multiplexer +- [fish][fish] - The friendly interactive shell + +## Installation + +```sh +make package=tmux +``` + +## Usage + +Start tmux as you normally would. + +[tmux]: https://www.archlinux.org/packages/community/x86_64/tmux/ +[fish]: https://www.archlinux.org/packages/community/x86_64/fish/