aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike McQuaid2014-12-27 11:05:11 +0000
committerMike McQuaid2014-12-27 11:05:11 +0000
commit995ee81399c5d056d26cfe531fd43dad3408e603 (patch)
treee843cc4584dea5eb7df57f39ac6abd4162571c30
parent34f58a597161bb1fd90a942681d3a0d4342d0acb (diff)
downloadhomebrew-995ee81399c5d056d26cfe531fd43dad3408e603.tar.bz2
tap-readme: tweak the format.
-rw-r--r--Library/Homebrew/cmd/tap-readme.rb23
1 files changed, 10 insertions, 13 deletions
diff --git a/Library/Homebrew/cmd/tap-readme.rb b/Library/Homebrew/cmd/tap-readme.rb
index 7e6f8a1c9..3ec901bee 100644
--- a/Library/Homebrew/cmd/tap-readme.rb
+++ b/Library/Homebrew/cmd/tap-readme.rb
@@ -1,30 +1,27 @@
module Homebrew
def tap_readme
name = ARGV.first
-
raise "A name is required" if name.nil?
+ titleized_name = name.dup
+ titleized_name[0] = titleized_name[0].upcase
+
template = <<-EOS.undent
- Homebrew-#{name}
- =========#{'=' * name.size}
+ # Homebrew #{titleized_name}
- How do I install these formulae?
- --------------------------------
- Just `brew tap homebrew/#{name}` and then `brew install <formula>`.
+ ## How do I install these formulae?
+ `brew install homebrew/#{name}/<formula>`
- If the formula conflicts with one from Homebrew/homebrew or another tap, you can `brew install homebrew/#{name}/<formula>`.
+ Or `brew tap homebrew/#{name}` and then `brew install <formula>`.
- You can also install via URL:
+ Or install via URL (which will not receive updates):
```
brew install https://raw.githubusercontent.com/Homebrew/homebrew-#{name}/master/<formula>.rb
```
- Docs
- ----
- `brew help`, `man brew`, or the Homebrew [docs][].
-
- [docs]:https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/README.md#readme
+ ## Documentation
+ `brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme).
EOS
puts template if ARGV.verbose?