From eb518e2953754563988275171cfe1cd5ed8e2edd Mon Sep 17 00:00:00 2001 From: Keil Miller Jr Date: Mon, 15 Oct 2012 22:57:19 -0400 Subject: [PATCH] Changed read me and GitkeepDir.rb filename I changed the readme to a more descriptive one. I changed the case of GitkeepDir.rb to GitKeep.rb to make it more uniform with repo name and readme. Signed-off-by: Keil Miller Jr --- GitkeepDir.rb => GitKeepDir.rb | 0 README.rdoc | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) rename GitkeepDir.rb => GitKeepDir.rb (100%) create mode 100644 README.rdoc diff --git a/GitkeepDir.rb b/GitKeepDir.rb similarity index 100% rename from GitkeepDir.rb rename to GitKeepDir.rb diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000..a23660f --- /dev/null +++ b/README.rdoc @@ -0,0 +1,28 @@ +== Welcome to GitKeepDir + +Git cannot add a completely empty directory. People who want to track empty directories in Git have created the convention of putting files called “.gitkeep” in these directories. This ruby script will automatically add .gitkeep files to empty directories, and remove .gitkeep files from directories with files or folders in them. + +== Getting Started + +=== Option 1 + +1. Move GitKeepDir.rb to the root of your repository. + +2. $ cd to your repository directory. + +3. Run in the terminal: + + $ ./GitkeepDir.rb + +=== Option 2 + +1. Drag GitKeepDir.rb to the terminal. + +2. Drag repository directories after GitKeepDir.rb to process. Example: + + $ ~/Desktop/GitkeepDir.rb ~/projects/myapp ~/projects/myotherapp + + +== Copyright + +Remyabi 2012 \ No newline at end of file