Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 55 lines (30 sloc) 1.961 kb
595c533 Josh Nichols Converted README to markdown.
authored
1 # homesick
0277901 Josh Nichols SPIIIIIKE
authored
2
55f367e Josh Nichols You can has docs.
authored
3 A man's home (directory) is his castle, so don't leave home with out it.
4
55d47ea Josh Nichols Added link to rip in readme.
authored
5 Homesick is sorta like [rip](http://github.com/defunkt/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.
55f367e Josh Nichols You can has docs.
authored
6
7 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:
8
9 * Contains a 'home' directory
10 * 'home' contains any number of files and directories that begin with '.'
11
12 To get started, install homesick first:
13
14 gem install homesick
15
16 Next, you use the homesick command to clone a castle:
17
18 homesick clone git://github.com/technicalpickles/pickled-vim.git
19
20 Alternatively, if it's on github, there's a slightly shorter way:
21
22 homesick clone technicalpickles/pickled-vim
23
24 With the castle cloned, you can now link its contents into your home dir:
25
43facf1 Josh Nichols Renamed 'link' command to 'symlink'
authored
26 homesick symlink pickled-vim
55f367e Josh Nichols You can has docs.
authored
27
06846af Sam Whitlock Fixed minor spelling error in README
samwhitlock authored
28 If you use the shorthand syntax for GitHub repositories in your clone, please note you will instead need to run:
53ed569 Darcy Laycock Add note to readme re. github and symlink
Sutto authored
29
30 homesick symlink technicalpickles/pickled-vim
31
55f367e Josh Nichols You can has docs.
authored
32 If you're not sure what castles you have around, you can easily list them:
33
34 homesick list
0277901 Josh Nichols SPIIIIIKE
authored
35
43facf1 Josh Nichols Renamed 'link' command to 'symlink'
authored
36 Not sure what else homesick has up its sleeve? There's always the built in help:
37
38 homesick help
39
595c533 Josh Nichols Converted README to markdown.
authored
40 ## Note on Patches/Pull Requests
0277901 Josh Nichols SPIIIIIKE
authored
41
42 * Fork the project.
43 * Make your feature addition or bug fix.
55f367e Josh Nichols You can has docs.
authored
44 * Add tests for it. This is important so I don't break it in a future version unintentionally.
45 * 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)
0277901 Josh Nichols SPIIIIIKE
authored
46 * Send me a pull request. Bonus points for topic branches.
47
453bd8f Josh Nichols Add link to homeshick.
authored
48 ## Need homesick without the ruby dependency?
49
50 Check out [homeshick](https://github.com/andsens/homeshick).
51
595c533 Josh Nichols Converted README to markdown.
authored
52 ## Copyright
0277901 Josh Nichols SPIIIIIKE
authored
53
54 Copyright (c) 2010 Joshua Nichols. See LICENSE for details.
Something went wrong with that request. Please try again.