2014-10-26 15:23:42 +00:00
# Homebrew
2016-10-12 21:38:59 -04:00
Features, usage and installation instructions are [summarised on the homepage ](http://brew.sh ). Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained here ](docs/Formula-Cookbook.md#homebrew-terminology ).
2010-10-21 09:34:54 -07:00
2016-08-13 08:45:36 +01:00
## Update Bug
If Homebrew was updated on Aug 10-11th 2016 and `brew update` always says `Already up-to-date.` you need to run:
```bash
2016-09-07 11:21:41 -04:00
cd "$(brew --repo)" & & git fetch & & git reset --hard origin/master & & brew update
2016-08-13 08:45:36 +01:00
```
2014-10-26 15:23:42 +00:00
## What Packages Are Available?
2014-10-26 15:26:10 +00:00
1. Type `brew search` for a list.
2. Or visit [braumeister.org ](http://braumeister.org ) to browse packages online.
2016-05-26 07:45:25 -07:00
3. Or use `brew search --desc <keyword>` to browse packages from the command line.
2010-10-21 09:34:54 -07:00
2014-10-26 15:23:42 +00:00
## More Documentation
2017-01-25 15:02:05 +01:00
`brew help` , `man brew` or check [our documentation ](http://docs.brew.sh/ ).
2009-08-31 16:01:36 +01:00
2014-10-26 15:23:42 +00:00
## Troubleshooting
2014-01-18 14:31:20 -08:00
First, please run `brew update` and `brew doctor` .
2017-01-04 11:13:41 +00:00
Second, read the [Troubleshooting Checklist ](http://docs.brew.sh/Troubleshooting.html ).
2014-01-18 14:31:20 -08:00
**If you don't read these it will take us far longer to help you with your problem.**
2016-07-26 20:07:04 -06:00
## Contributing
2016-09-20 11:51:06 +01:00
We'd love you to contribute to Homebrew. First, please read our [Contribution Guide ](https://github.com/Homebrew/brew/blob/master/CONTRIBUTING.md ) and [Code of Conduct ](https://github.com/Homebrew/brew/blob/master/CODEOFCONDUCT.md#code-of-conduct ).
2016-07-26 20:07:04 -06:00
We explicitly welcome contributions from people who have never contributed to open-source before: we were all beginners once! We can help build on a partially working pull request with the aim of getting it merged. We are also actively seeking to diversify our contributors and especially welcome contributions from women from all backgrounds and people of colour.
2017-01-04 11:13:41 +00:00
A good starting point for contributing is running `brew audit` (or `brew audit --strict` ) with some of the packages you use (e.g. `brew audit wget` if you use `wget` ) and then read through the warnings, try to fix them until `brew audit` shows no results and [submit a pull request ](http://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html ). If no formulae you use have warnings you can run `brew audit` without arguments to have it run on all packages and pick one. Good luck!
2016-07-26 20:07:04 -06:00
2014-10-26 15:23:42 +00:00
## Security
2014-10-22 17:23:17 -05:00
Please report security issues to security@brew .sh.
2016-05-24 16:56:25 +01:00
This is our PGP key which is valid until May 24, 2017.
2015-07-08 16:06:05 -04:00
* Key ID: `0xE33A3D3CCE59E297`
2015-07-07 04:26:36 -04:00
* Fingerprint: `C657 8F76 2E23 441E C879 EC5C E33A 3D3C CE59 E297`
2015-06-20 17:54:54 +08:00
* Full key: https://keybase.io/homebrew/key.asc
2014-10-26 15:23:42 +00:00
## Who Are You?
2016-09-20 09:30:42 +01:00
Homebrew's lead maintainer is [Mike McQuaid ](https://github.com/mikemcquaid ).
2017-01-04 10:53:21 +00:00
Homebrew's current maintainers are [Misty De Meo ](https://github.com/mistydemeo ), [Andrew Janke ](https://github.com/apjanke ), [Xu Cheng ](https://github.com/xu-cheng ), [Tomasz Pajor ](https://github.com/nijikon ), [Josh Hagins ](https://github.com/jawshooah ), [Baptiste Fontaine ](https://github.com/bfontaine ), [Markus Reiter ](https://github.com/reitermarkus ), [ilovezfs ](https://github.com/ilovezfs ), [Tom Schoonjans ](https://github.com/tschoonj ), [Uladzislau Shablinski ](https://github.com/vladshablinsky ), [Tim Smith ](https://github.com/tdsmith ) and [Alex Dunn ](https://github.com/dunn ).
2014-10-26 15:23:42 +00:00
2017-01-04 10:53:21 +00:00
Former maintainers with significant contributions include [Martin Afanasjew ](https://github.com/UniqMartin ), [Dominyk Tiller ](https://github.com/DomT4 ), [Brett Koonce ](https://github.com/asparagui ), [Jack Nagel ](https://github.com/jacknagel ), [Adam Vandenberg ](https://github.com/adamv ) and Homebrew's creator: [Max Howell ](https://github.com/mxcl ).
## Community
- [discourse.brew.sh (forum) ](http://discourse.brew.sh )
- [freenode.net\#machomebrew (IRC) ](irc://irc.freenode.net/#machomebrew )
- [@MacHomebrew (Twitter) ](https://twitter.com/MacHomebrew )
2014-10-26 15:23:42 +00:00
## License
2016-12-01 16:11:30 +00:00
Code is under the [BSD 2-clause "Simplified" License ](https://github.com/Homebrew/brew/tree/master/LICENSE.txt ).
2015-10-13 12:04:38 +01:00
Documentation is under the [Creative Commons Attribution license ](https://creativecommons.org/licenses/by/4.0/ ).
2014-10-26 15:23:42 +00:00
2016-02-23 10:26:31 +00:00
## Donations
2016-02-24 15:40:30 -08:00
Homebrew is a non-profit project run entirely by unpaid volunteers. We need your funds to pay for software, hardware and hosting around continuous integration and future improvements to the project. Every donation will be spent on making Homebrew better for our users.
2016-02-23 10:26:31 +00:00
2016-11-23 13:23:28 +00:00
Please consider a regular donation through Patreon:
2016-11-23 13:23:45 +00:00
2016-11-23 13:23:28 +00:00
[](https://www.patreon.com/homebrew)
2016-02-23 10:26:31 +00:00
2015-02-23 14:20:12 +00:00
## Sponsors
2017-01-04 11:13:41 +00:00
Our CI infrastructure was paid for by [our Kickstarter supporters ](http://docs.brew.sh/Kickstarter-Supporters.html ).
2015-02-23 14:20:12 +00:00
Our CI infrastructure is hosted by [The Positive Internet Company ](http://www.positive-internet.com ).
Our bottles (binary packages) are hosted by Bintray.
[](https://bintray.com/homebrew)
2016-02-23 10:26:31 +00:00
2016-06-02 10:17:40 +01:00
Secure password storage and syncing provided by [1Password for Teams ](https://1password.com/teams/ ) by AgileBits
[](https://agilebits.com)
2016-02-23 11:46:34 +00:00
Homebrew is a member of the [Software Freedom Conservancy ](https://sfconservancy.org )
2016-02-23 10:26:31 +00:00
2016-02-23 11:46:34 +00:00
[](https://sfconservancy.org)
