Updated README for .homesickrc.

This commit is contained in:
Jeremy Cook
2014-01-09 22:38:47 -05:00
parent 8a537b8204
commit 5fa0fc037c

View File

@@ -34,11 +34,11 @@ You can remove symlinks anytime when you don't need them anymore
homesick unlink pickled-vim
If you need to add further configuration steps you can add these in a file called '.homesickrc' in the root of a castle. Once you've cloned a castle with one of these files apply these steps with:
If you need to add further configuration steps you can add these in a file called '.homesickrc' in the root of a castle. Once you've cloned a castle with a .homesickrc run the configuration with:
homesick rc CASTLE
The contents of the .homesickrc file must be valid Ruby code as the file will be executed with Ruby's eval construct.
The contents of the .homesickrc file must be valid Ruby code as the file will be executed with Ruby's eval construct. The .homesickrc is also passed the current homesick object during its execution and this is available within the .homesickrc file as the 'self' variable.
If you're not sure what castles you have around, you can easily list them: