Added Readme

2025-01-17 19:41:41 -05:00 · 2025-01-17 19:41:41 -05:00 · 8872f2dd98
commit 8872f2dd98
parent ed7fef5dac
1 changed files with 30 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,30 @@
+# My dot files
+
+## Dependencies
+
+1. git
+2. paru
+3. picom
+4. tmux
+5. vim
+6. xorg
+7. zsh
+8. stow
+
+## Why are your dotfiles special?
+
+- My dotfiles specifically minimize the amount of folders your home directory has down to the minimum amount (baring browser dotfiles like `.mozilla` or `.waterfox`
+
+## how to use
+
+- clone into your home directory and use the `stow` command based on what you would like to use.
+
+- Ex.
+    1. `stow zsh`
+    2. `stow x11`
+    3. `stow vim`
+
+## Other notes
+
+- This is primarily for dwm, dmenu, dwmblocks, st, etc.
+- Also works for BSPWM and KDE with some adjustments