summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57f1fcb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# dotfiles
+
+## Usage
+
+```
+help Display this message
+TEMPLATES
+base Install base configurations for any machine
+desktop-base Install configurations for any desktop
+desktop-sway Install configurations for a Sway desktop
+CONFIGURATIONS
+Xresources .config/Xresources
+bash .bash_profile .bashrc
+fontconfig .config/fontconfig
+foot .config/foot
+fuzzel .config/fuzzel
+kanshi .config/kanshi
+lf .config/lf
+mako .config/mako
+mpd .config/mpd
+ncmpcpp .config/ncmpcpp
+nsxiv .config/nsxiv
+nvim .config/nvim
+scripts .local/bin .config/fzy-bookmark .config/fzy-tmux-project
+sway .config/sway
+tmux .config/tmux
+user-dirs .config/user-dirs.dirs
+wget .config/wget
+xdg-desktop-portal .config/xdg-desktop-portal
+```
+
+*Example help output, may contain outdated templates or configurations.*