From 6050a9a7acd23f04ad627d44f0c4076b6d8150ed Mon Sep 17 00:00:00 2001 From: Jeremy Cook Date: Thu, 9 Jan 2014 22:38:47 -0500 Subject: [PATCH] Updated README for .homesickrc. --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 6aad8d0..1069de3 100644 --- a/README.markdown +++ b/README.markdown @@ -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: