From: Adam Shamblin <adam@vexingworkshop.com>
Date: Wed, 16 Mar 2022 00:26:04 +0000 (-0600)
Subject: Update readme
X-Git-Url: https://git.vexinglabs.com/?a=commitdiff_plain;h=bc6811af55939c6106182d81547675129db080c6;p=dotfiles.git

Update readme
---

diff --git a/README.md b/README.md
index a2c6124..059ab0c 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,12 @@ days, and this is nothing more than that.  As I'll be moving around a bit in the
 coming months, I've decided to update a few things to make it easy to start on a
 new machine.
 
+## Usage
+
+After cloning this repository, running `make install` from within the project
+directory will symlink all dotfiles to thier appropriate locations in your home
+directory. To remove these files, run `make clean`.
+
 ## .bash\_profile
 
 Custom PS1, aliases, colors.
@@ -26,3 +32,13 @@ Submodules for my favorite plugins.
 * Flake8
 * Fugitive
 * Solarized
+* Gruvbox
+
+## xorg
+
+Simple key remappings and configuration for my monitors.
+
+## i3wm
+
+These files include all of my i3 desktop configuration, from basic usage and
+light theming to dmenu scripts and status bar.