README.rdoc in bones-2.1.1 vs README.rdoc in bones-2.2.0

- old
+ new

@@ -58,10 +58,11 @@ gem:install # Install the gem gem:package # Build all the packages gem:reinstall # Reinstall the gem gem:release # Package and upload to RubyForge gem:repackage # Force a rebuild of the package files + gem:spec # Write the gemspec gem:uninstall # Uninstall the gem git:create_tag # Create a new tag in the Git repository git:show_tags # Show tags from the Git repository manifest # Alias to manifest:check manifest:check # Verify the manifest @@ -84,11 +85,11 @@ == SYNOPSIS: To create a new "Get Fuzzy" project: - bones get_fuzzy + bones create get_fuzzy If you ever get confused about what Mr Bones can do: bones --help @@ -180,24 +181,24 @@ Bones when you create a new project. The default Mr Bones project skeleton is copied to the ".mrbones" directory in your home directory. From there, the skeleton can be modified however you like (add new files and tasks, add new directories, etc). - bones --freeze + bones freeze Typical uses of this feature would be to fill in user specific data like the author, e-mail address, etc. You can also add more default code to the skeleton project or your own ".rake" task files. You can have multiple skeletons with different names. Your projects can be instantiated from any of these skeletons. Just supply a name when freezing: - bones --freeze foo + bones freeze foo You can instantiate a project from the "foo" skeleton: - bones --skeleton foo get_fuzzy + bones create --skeleton foo get_fuzzy The default skeleton name is "data". If no skeleton name is provided, then this is the skeleton that will be used. ==== Unfreezing a Skeleton @@ -205,24 +206,47 @@ Unfreezing a skeleton will remove your customized project skeleton from the ".mrbones" directory. The default Mr Bones project skeleton will be used instead. A copy of your custom skeleton is stored in an archive directory of the ".mrbones" directory before it is removed. - bones --unfreeze + bones unfreeze You can unfreeze named skeletons, too: - bones --unfreeze foo + bones unfreeze foo +==== Repository Skeletons + +You can instantiate a new project from a git or svn repository. For example, +if you would like to use the "bort" rails template from github, you can type +in the following: + + bones create --repository git://github.com/fudgestudios/bort.git foo + +Typing in the full path to the repository each time is tedious. You can +create an alias by freezing the repository and giving it an easy to remember +name. + + bones freeze --repository git://github.com/fudgestudios/bort.git bort + +This does not checkout a copy of the repository; it give us an easy to use +alias when we want to create a new proejct based on the repository. The +following command will use our new alias to instantiate a new project called +"foo": + + bones create --skeleton bort foo + +If the repository contains '.bns' files they will be filtered through the +ERb templating system. All the custom modifications described in the next +section apply to repository based skeletons as well. + ==== Custom Modifications Mr Bones will perform a limited set of substitutions on the files in the skeleton when it generates a new project. ERB is used to insert the project name and the derived class name into template files. The file must end in an -".erb" suffix for ERB substitutions to take place. The ".erb" suffix is -stripped from the file during project generation. Therefore, your ERB files -should have two suffixes -- the ".erb" suffix that will be stripped, and the -suffix you want the resulting project file to have. +".bns" suffix for ERB substitutions to take place. The ".bns" suffix is +stripped from the file during project generation. Only two values can be substituted into files using ERB -- the project name and the derived class name. <%= name %>