diff --git a/README.md b/README.md index ecac193..680e0ee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # dotfiles .files + +## Installing + +To link the files to the correct places run + +``` +./install.fish +``` + +Make sure you have fish installed. + +### How it works + +The script takes the directories in `dirs.list` and creats them (if they don't +exist). After that it runs over `links.list` and takes the first path as source +(appending ~/dotfiles) and the path after the space as the target (appending +only ~/).