diff options
| author | Mike McQuaid | 2014-10-26 14:54:36 +0000 |
|---|---|---|
| committer | Mike McQuaid | 2014-10-26 14:57:36 +0000 |
| commit | 19d12aee45ac8d55ecd58a8c072286c84e72041d (patch) | |
| tree | f03c854a0c956a51def4853304aab021e60e635c /Library/Contributions/example-formula.rb | |
| parent | cd528e7203b649795113c7adc013f09a3b1aab73 (diff) | |
| download | brew-19d12aee45ac8d55ecd58a8c072286c84e72041d.tar.bz2 | |
Import docs from wiki.
Closes Homebrew/homebrew#33211.
Diffstat (limited to 'Library/Contributions/example-formula.rb')
| -rw-r--r-- | Library/Contributions/example-formula.rb | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Library/Contributions/example-formula.rb b/Library/Contributions/example-formula.rb index cb47261dc..b79f01777 100644 --- a/Library/Contributions/example-formula.rb +++ b/Library/Contributions/example-formula.rb @@ -3,7 +3,7 @@ require "formula" # This is a non-functional example formula to showcase all features and # therefore, it's overly complex and dupes stuff just to comment on it. # You may want to use `brew create` to start your own new formula! -# Documentation: https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook +# Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md ## Naming -- Every Homebrew formula is a class of the type `Formula`. # Ruby classes have to start Upper case and dashes are not allowed. @@ -87,8 +87,7 @@ class ExampleFormula < Formula # Bottles are pre-built and added by the Homebrew maintainers for you. # If you maintain your own repository, you can add your own bottle links. - # Read in the wiki about how to provide bottles: - # <https://github.com/Homebrew/homebrew/wiki/Bottles> + # https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Bottles.md bottle do root_url "http://mikemcquaid.com" # Optional root to calculate bottle URLs prefix "/opt/homebrew" # Optional HOMEBREW_PREFIX in which the bottles were built. @@ -413,8 +412,8 @@ end __END__ # Room for a patch after the `__END__` -# Read in the wiki about how to get a patch in here: -# https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook +# Read about how to get a patch in here: +# https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md # In short, `brew install --interactive --git <formula>` and make your edits. # Then `git diff >> path/to/your/formula.rb` # Note, that HOMEBREW_PREFIX will be replaced in the path before it is |