aether/gosick
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Converted README to markdown.

Browse Source
This commit is contained in:
Joshua Nichols
2010-04-01 00:13:06 -04:00
parent 43facf1ec0
commit 595c53370e
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.rdoc → README.markdown
View File

@@ -1,14 +1,13 @@
= homesick # homesick
A man's home (directory) is his castle, so don't leave home with out it. 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: 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 * Contains a 'home' directory
* 'home' contains any number of files and directories that begin with '.' * 'home' contains any number of files and directories that begin with '.'
* Optionally has a README file
To get started, install homesick first: 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 homesick help
== Note on Patches/Pull Requests ## Note on Patches/Pull Requests
* Fork the project. * Fork the project.
* Make your feature addition or bug fix. * 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) * 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. * Send me a pull request. Bonus points for topic branches.
== Copyright ## Copyright
Copyright (c) 2010 Joshua Nichols. See LICENSE for details. Copyright (c) 2010 Joshua Nichols. See LICENSE for details.