Move README to README.md

This commit is contained in:
Eryn Wells 2012-04-16 12:29:23 -07:00
parent 70c4118fa5
commit aa77d1997a

32
README.md Normal file
View file

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