From c3f85fc871c3274c2df72186f6eb72fa493e7f23 Mon Sep 17 00:00:00 2001
From: Donovan Glover <donovan@dglover.co>
Date: Tue, 23 Oct 2018 12:54:47 -0400
Subject: [PATCH] docs: Add READMEs for fish, vim, and xmodmap

Since I'd like other people to try my dotfiles, I will be writing
READMEs for each package directory, which should hopefully cover
anything a user needs to do in order to use the package.
---
 fish/README.md    | 19 +++++++++++++++++++
 vim/README.md     | 31 +++++++++++++++++++++++++++++++
 xmodmap/README.md | 30 ++++++++++++++++++++++++++++++
 3 files changed, 80 insertions(+)
 create mode 100644 fish/README.md
 create mode 100644 vim/README.md
 create mode 100644 xmodmap/README.md

diff --git a/fish/README.md b/fish/README.md
new file mode 100644
index 0000000..3bbb2de
--- /dev/null
+++ b/fish/README.md
@@ -0,0 +1,19 @@
+# fish - the friendly interactive shell
+
+I use fish as my default shell of choice, and write scripts in `sh`.
+
+## Dependencies
+
+- `fish` - The friendly interactive shell
+- `exa` - Drop-in replacement for `ls` and `tree`
+- Any other features that you want to use (git abbreviations, etc.)
+
+## Installation
+
+```sh
+make package=fish
+```
+
+## Usage
+
+The dotfiles are automatically applied when you start fish.
diff --git a/vim/README.md b/vim/README.md
new file mode 100644
index 0000000..2b296f4
--- /dev/null
+++ b/vim/README.md
@@ -0,0 +1,31 @@
+# Vim
+
+I use neovim as my main text editor, and vim elsewhere.
+
+## Dependencies
+
+- `vim` - If you're reading this, you probably already know what vim is
+- `neovim` - An improved version of vim (cursor modes, sane defaults, etc.)
+- `wal` - Changing color schemes support
+- `fzf` - Fuzzy search support
+- `ripgrep` - Jump between lines in files
+- `git` - Git diff support
+- Any other features you want to use (e.g. TeX support with `texlive`)
+
+## Installation
+
+```sh
+make package=vim
+```
+
+## Usage
+
+I use [vim-plug][vim-plug] as my plugin manager of choice. Install it, then run:
+
+```
+vim +PlugInstall +qall
+```
+
+Now you can use my vim config with all the plugins installed!
+
+[vim-plug]: https://github.com/junegunn/vim-plug
diff --git a/xmodmap/README.md b/xmodmap/README.md
new file mode 100644
index 0000000..9cb8475
--- /dev/null
+++ b/xmodmap/README.md
@@ -0,0 +1,30 @@
+# xmodmap
+
+I use xmodmap with xcape to make Caps Lock function as Escape when pressed and Ctrl when held down.
+
+## Dependencies
+
+- `xorg-xmodmap` - Used to make caps lock work as ctrl
+- `xcape` - Used to make caps lock work as escape
+
+## Installation
+
+```sh
+make package=xmodmap
+```
+
+## Usage
+
+Start `xmodmap` in one of your init scripts, like so:
+
+```sh
+# Make caps lock work as ctrl
+xmodmap ~/.xmodmap
+```
+
+To make caps lock work as Escape, start xcape as well:
+
+```sh
+# Make caps lock (left ctrl) work as escape
+xcape -e 'Control_L=Escape'
+```