blob: cf5af85ebc168b6c1ee122041797ccbba6600c3a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
#: * `tap_readme` [`-v`] <name>:
#: Generate the README.md file for a new tap.
module Homebrew
module_function
def tap_readme
name = ARGV.first
raise "A name is required" if name.nil?
titleized_name = name.dup
titleized_name[0..0] = titleized_name[0..0].upcase
template = <<-EOS.undent
# Homebrew #{titleized_name}
## How do I install these formulae?
`brew install homebrew/#{name}/<formula>`
Or `brew tap homebrew/#{name}` and then `brew install <formula>`.
Or install via URL (which will not receive updates):
```
brew install https://raw.githubusercontent.com/Homebrew/homebrew-#{name}/master/<formula>.rb
```
## Documentation
`brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/docs#readme).
EOS
puts template if ARGV.verbose?
path = HOMEBREW_LIBRARY/"Taps/homebrew/homebrew-#{name}/README.md"
raise "#{path} already exists" if path.exist?
path.write template
end
end
|
