diff options
| author | Mike McQuaid | 2015-10-26 21:04:12 -0600 |
|---|---|---|
| committer | Mike McQuaid | 2015-10-27 10:45:23 -0600 |
| commit | 74e407dc548f397159ee0eab6d0921bd0666b3b3 (patch) | |
| tree | d1b35fc3864fd1f2b10e14ee9b8b75d7e995eb65 /share/doc | |
| parent | 8ea9903a99fce3d7bcd432200f1bd2170e81de43 (diff) | |
| download | brew-74e407dc548f397159ee0eab6d0921bd0666b3b3.tar.bz2 | |
The Formula API is no longer work-in-progress.
Feature it a bit more prominently in the documentation as a result.
Closes Homebrew/homebrew#45374.
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'share/doc')
| -rw-r--r-- | share/doc/homebrew/Formula-Cookbook.md | 5 | ||||
| -rw-r--r-- | share/doc/homebrew/brew.1.html | 4 |
2 files changed, 5 insertions, 4 deletions
diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md index 1de9b9487..d5ad7a124 100644 --- a/share/doc/homebrew/Formula-Cookbook.md +++ b/share/doc/homebrew/Formula-Cookbook.md @@ -3,6 +3,9 @@ Making a formula is easy. Just `brew create URL` and then `brew install $FORMULA We want your formula to be awesome, and the cookbook will tell you how. +## API documentation +Some people find it easier to jump straight into API documentation rather than a walkthrough. If you're one of these check out the [Formula API](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula) which shows all the stuff you can use in a Homebrew Formula. + ## Terminology - Homebrew speak <table> @@ -82,8 +85,6 @@ Formulae aren’t that complicated. [etl](https://github.com/Homebrew/homebrew/b And then [Git](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/git.rb) and [flac](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/flac.rb) show more advanced functionality. -Refer to the [Formula class API documentation](http://www.rubydoc.info/github/Homebrew/homebrew/master/frames) which shows all the stuff you can use in a Formula. - ## Grab the URL All you need to make a formula is a URL to the tarball. diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 33d770f31..b016f8777 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -82,9 +82,9 @@ provide it.</p></li> Generate a formula for the downloadable file at <var>URL</var> and open it in the editor. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you'll have to make your own template. The wget -formula serves as a simple example. For a complete cheat-sheet, have a look at</p> +formula serves as a simple example. For the complete API have a look at</p> -<p><a href="http://www.rubydoc.info/github/Homebrew/homebrew/master/frames" data-bare-link="true">http://www.rubydoc.info/github/Homebrew/homebrew/master/frames</a></p> +<p><a href="http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula" data-bare-link="true">http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula</a></p> <p>If <code>--autotools</code> is passed, create a basic template for an Autotools-style build. If <code>--cmake</code> is passed, create a basic template for a CMake-style build.</p> |