Add a stub of a README

This commit is contained in:
Salt 2021-01-19 01:27:55 -06:00
parent 5e55222650
commit 51be586f1d

22
README.md Normal file
View File

@ -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