Skip to content

Commit

Permalink
You can has docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
technicalpickles committed Mar 10, 2010
1 parent ec9948a commit 55f367e
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,41 @@
= homesick

Homesick is like rip, but for dotfiles. It keeps clones of peoples' git-version
dotfiles in the ~/.homesick/ directory, and then allows you to very easily
symlink all the dotfiles from any one of your cloned repos into place.
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.

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:

gem install homesick

Next, you use the homesick command to clone a castle:

homesick clone git://github.com/technicalpickles/pickled-vim.git

Alternatively, if it's on github, there's a slightly shorter way:

homesick clone technicalpickles/pickled-vim

With the castle cloned, you can now link its contents into your home dir:

homesick link pickled-vim

If you're not sure what castles you have around, you can easily list them:

homesick list

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* 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)
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* 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
Expand Down

0 comments on commit 55f367e

Please sign in to comment.