aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew
diff options
context:
space:
mode:
Diffstat (limited to 'Library/Homebrew')
-rwxr-xr-xLibrary/Homebrew/cmd/tap-readme.rb35
1 files changed, 35 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/tap-readme.rb b/Library/Homebrew/cmd/tap-readme.rb
new file mode 100755
index 000000000..6356fe308
--- /dev/null
+++ b/Library/Homebrew/cmd/tap-readme.rb
@@ -0,0 +1,35 @@
+module Homebrew
+ def tap_readme
+ 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 Homebrew/homebrew or another tap, you can `brew install homebrew/#{name}/<formula>`.
+
+ You can also install via URL:
+
+ ```
+ brew install https://raw.githubusercontent.com/Homebrew/homebrew-#{name}/master/<formula>.rb
+ ```
+
+ Docs
+ ----
+ `brew help`, `man brew`, or the Homebrew [wiki][].
+
+ [wiki]:http://wiki.github.com/Homebrew/homebrew
+ EOS
+
+ puts template if ARGV.verbose?
+ path = Pathname.new('./README.md')
+ raise "#{path} already exists" if path.exist?
+ path.write template
+ end
+end