From 595c53370e21fdd09dfecc6b024b28272ec7f6f3 Mon Sep 17 00:00:00 2001 From: Joshua Nichols Date: Thu, 1 Apr 2010 00:13:06 -0400 Subject: [PATCH] Converted README to markdown. --- README.rdoc => README.markdown | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) rename README.rdoc => README.markdown (85%) diff --git a/README.rdoc b/README.markdown similarity index 85% rename from README.rdoc rename to README.markdown index 945cb8f..c46328c 100644 --- a/README.rdoc +++ b/README.markdown @@ -1,14 +1,13 @@ -= homesick +# homesick A man's home (directory) is his castle, so don't leave home with out it. -Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in ~/.homesick. It then allows you to symlink all the dotfiles into place with a single command. +Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in `~/.homesick`. It then allows you to symlink all the dotfiles into place with a single command. We call a repository that is compatible with homesick to be a 'castle'. To act as a castle, a repository must be organized like so: * Contains a 'home' directory * 'home' contains any number of files and directories that begin with '.' -* Optionally has a README file To get started, install homesick first: @@ -34,7 +33,7 @@ Not sure what else homesick has up its sleeve? There's always the built in help: homesick help -== Note on Patches/Pull Requests +## Note on Patches/Pull Requests * Fork the project. * Make your feature addition or bug fix. @@ -42,6 +41,6 @@ Not sure what else homesick has up its sleeve? There's always the built in help: * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) * Send me a pull request. Bonus points for topic branches. -== Copyright +## Copyright Copyright (c) 2010 Joshua Nichols. See LICENSE for details.