From 70c4118fa568e81ba7c637b758872bbcef162d6d Mon Sep 17 00:00:00 2001 From: Eryn Wells Date: Mon, 16 Apr 2012 12:28:00 -0700 Subject: [PATCH] Add README --- README | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..31262c9 --- /dev/null +++ b/README @@ -0,0 +1,32 @@ +Dotfiles +======== + +This is my collection of dotfiles, preserved here for all to see and enjoy. +Feel free to copy anything you see here. It would be nice if you added a +comment mentioning where you got it. + +My environment relies on `zsh`, `vim`, and `git`. + +## Installation + +Clone the repository to a directory on your machine. I like to use +`~/.dotfiles`. + + git clone https://github.com/erynofwales/dotfiles.git ~/.dotfiles + +Run the setup script. + + cd ~/.dotfiles + ./setup.sh + +This script will symlink all the files in the directory to your home directory +and initialize the various submodules (mostly Vim plugins). + +Enjoy. + +## License + +Everything in this repository is licensed under the [Creative Commons +Attribution 3.0 Unported License][ccaul]. + +[ccaul]: http://creativecommons.org/licenses/by/3.0/