diff --git a/README.md b/README.md new file mode 100644 index 00000000..cef4e29c --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Salt's Dotfiles + +GNU Stow Edition + +## Installation + +Clone the repository and stow in configs that you want, like so: + +```bash +cd +git clone git@git.desu.ltd:salt/dotfiles .dotfiles +cd .dotfiles +stow vim # Or whatever config set you want +``` + +I would highly recommend using this repository only as a reference and building your own dotfile solution from scratch. + +However, I would *also* highly recommend using this stow-based approach instead of putting a bare repo in your home directory. Been there, done that. It sucks, especially if you're the type to diverge configs between machines or just want a subset installed. + +## Overview + +TODO: Overview of config sets