Permalink
Browse files

Added first readme

  • Loading branch information...
1 parent 634f0c6 commit d9a78303ea62f1f177684eaecf65c0c6b7af1b0d Flavio Pellanda committed Feb 10, 2012
Showing with 23 additions and 0 deletions.
  1. +23 −0 README
  2. 0 examples/{multistrap.conf → multistrap.it}
View
23 README
@@ -0,0 +1,23 @@
+= Synopsis
+
+Have you ever wanted to run a simple command, but the command needed a configuration file? You could create a configuration file, but if you want to run the command slightly different you have to change the configuration file again... at this point I normally gave up - but now the solution is 'it'.
+
+Inline Template: Crate a "wrapper" command that contains a configurable configuration file inline. Use pure ruby and ERB to create your configuration on the fly, and the command will be executed for you.
+
+== Example
+
+I wanted to create a simple "Lenny" bootstraped jail with multistrap, I thought I could run something like:
+
+ root@localhost# multistrap --suite lenny --directory /tmp/lenny_chroot
+
+But when running the command, this is the result:
+
+ root@localhost# multistrap
+ Need a configuration file - use multistrap -f
+
+An the documentation doesn't help either:
+
+ multistrap [-a ARCH] [-d DIR] -f CONFIG_FILE
+
+And the solution is a 'it' script - you can use pure ruby and ERB.
+
File renamed without changes.

0 comments on commit d9a7830

Please sign in to comment.