aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd
diff options
context:
space:
mode:
authorMike McQuaid2014-12-27 11:05:11 +0000
committerMike McQuaid2014-12-27 11:05:11 +0000
commitf22aeb14f613d4e9257e0e7e451d5004e59e4d06 (patch)
tree71964e206490d63b8e6598c3075638191c56586a /Library/Homebrew/cmd
parenta14c922b790b1bfc088a61a5190f348e5381a9ea (diff)
downloadbrew-f22aeb14f613d4e9257e0e7e451d5004e59e4d06.tar.bz2
tap-readme: tweak the format.
Diffstat (limited to 'Library/Homebrew/cmd')
-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?