aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Contributions
diff options
context:
space:
mode:
authorAdam Vandenberg2013-05-31 14:44:45 -0700
committerAdam Vandenberg2013-05-31 14:45:43 -0700
commitfa05fc2451fd7598c32d76edac44c24efacd753c (patch)
tree1e190b644af63a6cb4bcee64edd6aa4202a3915c /Library/Contributions
parent903c340664a32ce37fef58de9719d4176f723301 (diff)
downloadbrew-fa05fc2451fd7598c32d76edac44c24efacd753c.tar.bz2
Add `brew tap-readme <name>` external command.
Closes Homebrew/homebrew#17935.
Diffstat (limited to 'Library/Contributions')
-rwxr-xr-xLibrary/Contributions/cmd/brew-tap-readme.rb32
1 files changed, 32 insertions, 0 deletions
diff --git a/Library/Contributions/cmd/brew-tap-readme.rb b/Library/Contributions/cmd/brew-tap-readme.rb
new file mode 100755
index 000000000..1aac1b06d
--- /dev/null
+++ b/Library/Contributions/cmd/brew-tap-readme.rb
@@ -0,0 +1,32 @@
+name = ARGV.first
+
+raise "A name is required" if name.nil?
+
+template = <<-EOS
+Homebrew-#{name}
+=========#{'=' * name.size}
+
+How do I install these formulae?
+--------------------------------
+Just `brew tap homebrew/#{name}` and then `brew install <formula>`.
+
+If the formula conflicts with one from mxcl/master or another tap, you can `brew install homebrew/#{name}/<formula>`.
+
+You can also install via URL:
+
+```
+brew install https://raw.github.com/Homebrew/homebrew-#{name}/master/<formula>.rb
+```
+
+Docs
+----
+`brew help`, `man brew`, or the Homebrew [wiki][].
+
+[wiki]:http://wiki.github.com/mxcl/homebrew
+EOS
+
+# puts ERB.new(template, nil, '>').result(binding)
+puts template if ARGV.verbose?
+path = Pathname.new('./README.md')
+raise "#{path} already exists" if path.exist?
+path.write template