Update documentation after repository split.
Mike McQuaid
parent
51800ddecb
commit
82dbbfb4b1
|
|
@ -1,38 +1,38 @@
|
|||
# Contributing to Homebrew
|
||||
|
||||
First time contributing to Homebrew? Read our [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md#code-of-conduct).
|
||||
First time contributing to Homebrew? Read our [Code of Conduct](https://github.com/Homebrew/brew/blob/master/CODEOFCONDUCT.md#code-of-conduct).
|
||||
|
||||
### Report a bug
|
||||
|
||||
* run `brew update` (twice)
|
||||
* run and read `brew doctor`
|
||||
* read [the Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting)
|
||||
* read [the Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting)
|
||||
* open an issue on the formula's repository
|
||||
|
||||
### Submit a `1.2.3` version upgrade for the `foo` formula
|
||||
|
||||
* check if the same upgrade has been already submitted by [searching the open pull requests for `foo`](https://github.com/Homebrew/homebrew-core/pulls?utf8=✓&q=is%3Apr+is%3Aopen+foo).
|
||||
* `brew edit foo`
|
||||
* edit [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is
|
||||
* edit [`url`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#bottle-class_method) as-is
|
||||
* `brew install foo`
|
||||
* run `brew audit foo` and fix any issues
|
||||
* `git commit` with commit subject `foo 1.2.3`
|
||||
* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
* [open a pull request](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
|
||||
### Add a new formula for `foo` version `2.3.4` from `$URL`
|
||||
|
||||
* read [the Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits
|
||||
* read [the Formula Cookbook](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits
|
||||
* `brew install foo`
|
||||
* `brew audit --online --strict foo`
|
||||
* `git commit` with message formatted `foo 2.3.4 (new formula)`
|
||||
* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
* [open a pull request](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
|
||||
### Contribute a fix to the `foo` formula
|
||||
|
||||
* `brew edit foo` and make edits
|
||||
* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is
|
||||
* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#bottle-class_method) as-is
|
||||
* `brew install foo`, `brew test foo`, and `brew audit foo`
|
||||
* `git commit` with message formatted `foo: fix <insert details>`
|
||||
* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
* [open a pull request](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests
|
||||
|
||||
Thanks!
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ Please replace this line with a brief summary of your issue **AND** if reporting
|
|||
`brew gist-logs <formula>`
|
||||
(where `<formula>` is the name of the formula that failed to build).
|
||||
|
||||
### Feature/Formula Requests:
|
||||
### Formula Requests:
|
||||
|
||||
**Please note by far the quickest way to get a new feature or formula into Homebrew is to file a [Pull Request](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md).**
|
||||
**Please note by far the quickest way to get a new formula into Homebrew is to file a [Pull Request](https://github.com/Homebrew/homebrew-core/blob/master/.github/CONTRIBUTING.md).**
|
||||
|
||||
We will consider your request but it may be closed if it's something we're not actively planning to work on.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,4 @@
|
|||
### All Submissions:
|
||||
|
||||
- [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md) document?
|
||||
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/homebrew-core/pulls) for the same update/change?
|
||||
|
||||
### New or Updated Formulae Submissions:
|
||||
|
||||
- [ ] Does your submission pass
|
||||
`brew audit --strict --online <formula>` (where `<formula>` is the name of the formula you're submitting)?
|
||||
- [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/homebrew-core/blob/master/.github/CONTRIBUTING.md) document?
|
||||
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/homebrew-core/pulls) for the same formula update/change?
|
||||
- [ ] Does your submission pass `brew audit --strict --online <formula>` (where `<formula>` is the name of the formula you're submitting)?
|
||||
- [ ] Have you built your formula locally prior to submission with `brew install <formula>`?
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ class Pypy < Formula
|
|||
To update setuptools and pip between pypy releases, run:
|
||||
pip_pypy install --upgrade pip setuptools
|
||||
|
||||
See: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
EOS
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ class Pypy3 < Formula
|
|||
To update pip and setuptools between pypy3 releases, run:
|
||||
pip_pypy3 install --upgrade pip setuptools
|
||||
|
||||
See: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
EOS
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -273,7 +273,7 @@ class Python < Formula
|
|||
<<-EOF.undent
|
||||
# This file is created by Homebrew and is executed on each python startup.
|
||||
# Don't print from here, or else python command line scripts may fail!
|
||||
# <https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
||||
# <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
||||
import re
|
||||
import os
|
||||
import sys
|
||||
|
|
@ -329,7 +329,7 @@ class Python < Formula
|
|||
They will install into the site-package directory
|
||||
#{site_packages}
|
||||
|
||||
See: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
EOS
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -282,7 +282,7 @@ class Python3 < Formula
|
|||
<<-EOF.undent
|
||||
# This file is created by Homebrew and is executed on each python startup.
|
||||
# Don't print from here, or else python command line scripts may fail!
|
||||
# <https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
||||
# <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
||||
import re
|
||||
import os
|
||||
import sys
|
||||
|
|
@ -327,7 +327,7 @@ class Python3 < Formula
|
|||
They will install into the site-package directory
|
||||
#{site_packages}
|
||||
|
||||
See: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
||||
EOS
|
||||
|
||||
# Tk warning only for 10.6
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@ class SblimSfcc < Formula
|
|||
system "make", "install"
|
||||
end
|
||||
|
||||
# based on the test at #https://github.com/Homebrew/homebrew/blob/master/Library/Formula/tinyxml.rb
|
||||
test do
|
||||
(testpath/"test.cpp").write <<-EOS.undent
|
||||
#include <cimc/cimc.h>
|
||||
|
|
|
|||
|
|
@ -2,17 +2,17 @@
|
|||
Core formulae for the Homebrew package manager.
|
||||
|
||||
## How do I install these formulae?
|
||||
Just `brew install <formula>`. This is the default tap of Homebrew.
|
||||
Just `brew install <formula>`. This is the default tap for Homebrew and is installed by default.
|
||||
|
||||
## Troubleshooting
|
||||
First, please run `brew update` and `brew doctor`.
|
||||
|
||||
Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).
|
||||
Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).
|
||||
|
||||
**If you don’t read these it will take us far longer to help you with your problem.**
|
||||
|
||||
## 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`, [Homebrew/brew's README](https://github.com/Homebrew/brew#homebrew) or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme).
|
||||
|
||||
## License
|
||||
Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/homebrew-core/blob/master/LICENSE.txt).
|
||||
|
|
|
|||
Loading…
Reference in New Issue