tap-readme: tweak the format.
This commit is contained in:
parent
a14c922b79
commit
f22aeb14f6
@ -1,30 +1,27 @@
|
|||||||
module Homebrew
|
module Homebrew
|
||||||
def tap_readme
|
def tap_readme
|
||||||
name = ARGV.first
|
name = ARGV.first
|
||||||
|
|
||||||
raise "A name is required" if name.nil?
|
raise "A name is required" if name.nil?
|
||||||
|
|
||||||
|
titleized_name = name.dup
|
||||||
|
titleized_name[0] = titleized_name[0].upcase
|
||||||
|
|
||||||
template = <<-EOS.undent
|
template = <<-EOS.undent
|
||||||
Homebrew-#{name}
|
# Homebrew #{titleized_name}
|
||||||
=========#{'=' * name.size}
|
|
||||||
|
|
||||||
How do I install these formulae?
|
## How do I install these formulae?
|
||||||
--------------------------------
|
`brew install homebrew/#{name}/<formula>`
|
||||||
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>`.
|
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
|
brew install https://raw.githubusercontent.com/Homebrew/homebrew-#{name}/master/<formula>.rb
|
||||||
```
|
```
|
||||||
|
|
||||||
Docs
|
## Documentation
|
||||||
----
|
`brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme).
|
||||||
`brew help`, `man brew`, or the Homebrew [docs][].
|
|
||||||
|
|
||||||
[docs]:https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/README.md#readme
|
|
||||||
EOS
|
EOS
|
||||||
|
|
||||||
puts template if ARGV.verbose?
|
puts template if ARGV.verbose?
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user