README.md 8.4 KB
Newer Older
Mike McQuaid's avatar
Mike McQuaid 已提交
1
# Homebrew
Mike McQuaid's avatar
Mike McQuaid 已提交
2

Mike McQuaid's avatar
Mike McQuaid 已提交
3
4
[![GitHub release](https://img.shields.io/github/release/Homebrew/brew.svg)](https://github.com/Homebrew/brew/releases)

Mike McQuaid's avatar
Mike McQuaid 已提交
5
Features, usage and installation instructions are [summarised on the homepage](https://brew.sh). Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained here](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology).
Adam Vandenberg's avatar
Adam Vandenberg 已提交
6

Mike McQuaid's avatar
Mike McQuaid 已提交
7
## What Packages Are Available?
Mike McQuaid's avatar
Mike McQuaid 已提交
8

9
1. Type `brew formulae` for a list.
10
2. Or visit [formulae.brew.sh](https://formulae.brew.sh) to browse packages online.
Joe Gallo's avatar
Joe Gallo 已提交
11
3. Or use `brew search --desc <keyword>` to browse packages from the command line.
Adam Vandenberg's avatar
Adam Vandenberg 已提交
12

Mike McQuaid's avatar
Mike McQuaid 已提交
13
## More Documentation
Mike McQuaid's avatar
Mike McQuaid 已提交
14

15
`brew help`, `man brew` or check [our documentation](https://docs.brew.sh/).
Max Howell's avatar
Max Howell 已提交
16

Mike McQuaid's avatar
Mike McQuaid 已提交
17
## Troubleshooting
Mike McQuaid's avatar
Mike McQuaid 已提交
18

Mike McQuaid's avatar
Mike McQuaid 已提交
19
20
First, please run `brew update` and `brew doctor`.

21
Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting).
Mike McQuaid's avatar
Mike McQuaid 已提交
22
23
24

**If you don't read these it will take us far longer to help you with your problem.**

25
## Contributing
Mike McQuaid's avatar
Mike McQuaid 已提交
26

27
We'd love you to contribute to Homebrew. First, please read our [Contribution Guide](CONTRIBUTING.md) and [Code of Conduct](https://github.com/Homebrew/.github/blob/HEAD/CODE_OF_CONDUCT.md#code-of-conduct).
28
29
30

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.

31
A good starting point for contributing is running `brew audit --strict` with some of the packages you use (e.g. `brew audit --strict wget` if you use `wget`) and then read through the warnings, try to fix them until `brew audit --strict` shows no results and [submit a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request). If no formulae you use have warnings you can run `brew audit --strict` without arguments to have it run on all packages and pick one.
32
33
34
35

Alternatively, for something more substantial, check out one of the issues labeled `help wanted` in [Homebrew/brew](https://github.com/homebrew/brew/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or [Homebrew/homebrew-core](https://github.com/homebrew/homebrew-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).

Good luck!
36

Mike McQuaid's avatar
Mike McQuaid 已提交
37
## Donations
Mike McQuaid's avatar
Mike McQuaid 已提交
38

Mike McQuaid's avatar
Mike McQuaid 已提交
39
40
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.

41
Please consider a regular donation through [GitHub Sponsors](https://github.com/sponsors/Homebrew) or [Patreon](https://www.patreon.com/homebrew).
Mike McQuaid's avatar
Mike McQuaid 已提交
42
43
44
45
46
47
48
49
50
51
52
53
54

Alternatively, if you'd rather make a one-off payment:

- [Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V6ZE57MJRYC8L)
- Donate by USA $ check from a USA bank:
  - Make check payable to "Software Freedom Conservancy, Inc." and place "Directed donation: Homebrew" in the memo field. Checks should then be mailed to:
    - Software Freedom Conservancy, Inc.
      137 Montague ST  STE 380
      BROOKLYN, NY 11201             USA
- Donate by wire transfer: contact accounting@sfconservancy.org for wire transfer details.

Homebrew is a member of the [Software Freedom Conservancy](https://sfconservancy.org) which provides us with an ability to receive tax-deductible, Homebrew earmarked donations (and [many other services](https://sfconservancy.org/members/services/)). Software Freedom Conservancy, Inc. is a 501(c)(3) organization incorporated in New York, and donations made to it are fully tax-deductible to the extent permitted by law.

Mike McQuaid's avatar
Mike McQuaid 已提交
55
## Security
Mike McQuaid's avatar
Mike McQuaid 已提交
56

57
Please report security issues to our [HackerOne](https://hackerone.com/homebrew/).
Xu Cheng's avatar
Xu Cheng 已提交
58

Alexander Bayandin's avatar
Alexander Bayandin 已提交
59
## Who We Are
Mike McQuaid's avatar
Mike McQuaid 已提交
60

Pasta Ravioli's avatar
Pasta Ravioli 已提交
61
Homebrew's [Project Leader](https://docs.brew.sh/Homebrew-Governance#6-project-leader) is [Mike McQuaid](https://github.com/MikeMcQuaid).
62

63
Homebrew's [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee) is [Issy Long](https://github.com/issyl0), [Jonathan Chang](https://github.com/jonchang), [Markus Reiter](https://github.com/reitermarkus), [Misty De Meo](https://github.com/mistydemeo) and [Sean Molenaar](https://github.com/SMillerDev).
64

Mike McQuaid's avatar
Mike McQuaid 已提交
65
Homebrew's [Technical Steering Committee](https://docs.brew.sh/Homebrew-Governance#7-technical-steering-committee) is [Bo Anderson](https://github.com/Bo98), [FX Coudert](https://github.com/fxcoudert), [Michka Popoff](https://github.com/iMichka), [Mike McQuaid](https://github.com/MikeMcQuaid) and [Rylan Polster](https://github.com/Rylan12).
Mike McQuaid's avatar
Mike McQuaid 已提交
66

miccal's avatar
miccal 已提交
67
Homebrew's Linux maintainers are [Daniel Nachun](https://github.com/danielnachun), [Dawid Dziurla](https://github.com/dawidd6), [Issy Long](https://github.com/issyl0), [Jonathan Chang](https://github.com/jonchang), [Michka Popoff](https://github.com/iMichka) and [Shaun Jackman](https://github.com/sjackman).
68

69
Homebrew's other current maintainers are [Alexander Bayandin](https://github.com/bayandin), [Caleb Xu](https://github.com/alebcay), [Carlo Cabrera](https://github.com/carlocab), [Claudia Pellegrino](https://github.com/claui), [Connor Mann](https://github.com/cnnrmnn), [Dustin Rodrigues](https://github.com/dtrodrigues), [Eric Knibbe](https://github.com/EricFromCanada), [Maxim Belkin](https://github.com/maxim-belkin), [Miccal Matthews](https://github.com/miccal), [Michael Cho](https://github.com/cho-m), [Nanda H Krishna](https://github.com/nandahkrishna), [Randall](https://github.com/ran-dall), [Sam Ford](https://github.com/samford), [Steve Peters](https://github.com/scpeters), [Thierry Moisan](https://github.com/Moisan), [Tom Schoonjans](https://github.com/tschoonj), [Vítor Galvão](https://github.com/vitorgalvao) and [rui](https://github.com/chenrui333).
Mike McQuaid's avatar
Mike McQuaid 已提交
70

Mike McQuaid's avatar
Mike McQuaid 已提交
71
Former maintainers with significant contributions include [Jan Viljanen](https://github.com/javian), [JCount](https://github.com/jcount), [commitay](https://github.com/commitay), [Dominyk Tiller](https://github.com/DomT4), [Tim Smith](https://github.com/tdsmith), [Baptiste Fontaine](https://github.com/bfontaine), [Xu Cheng](https://github.com/xu-cheng), [Martin Afanasjew](https://github.com/UniqMartin), [Brett Koonce](https://github.com/asparagui), [Charlie Sharpsteen](https://github.com/Sharpie), [Jack Nagel](https://github.com/jacknagel), [Adam Vandenberg](https://github.com/adamv), [Andrew Janke](https://github.com/apjanke), [Alex Dunn](https://github.com/dunn), [neutric](https://github.com/neutric), [Tomasz Pajor](https://github.com/nijikon), [Uladzislau Shablinski](https://github.com/vladshablinsky), [Alyssa Ross](https://github.com/alyssais), [ilovezfs](https://github.com/ilovezfs), [Chongyu Zhu](https://github.com/lembacon) and Homebrew's creator: [Max Howell](https://github.com/mxcl).
Mike McQuaid's avatar
Mike McQuaid 已提交
72
73

## Community
Mike McQuaid's avatar
Mike McQuaid 已提交
74

75
- [Homebrew/discussions (forum)](https://github.com/homebrew/discussions/discussions)
Mike McQuaid's avatar
Mike McQuaid 已提交
76
- [@MacHomebrew (Twitter)](https://twitter.com/MacHomebrew)
Mike McQuaid's avatar
Mike McQuaid 已提交
77
78

## License
Mike McQuaid's avatar
Mike McQuaid 已提交
79

Maxim Belkin's avatar
Maxim Belkin 已提交
80
Code is under the [BSD 2-clause "Simplified" License](LICENSE.txt).
81
Documentation is under the [Creative Commons Attribution license](https://creativecommons.org/licenses/by/4.0/).
Mike McQuaid's avatar
Mike McQuaid 已提交
82

Mike McQuaid's avatar
Mike McQuaid 已提交
83
## Sponsors
Mike McQuaid's avatar
Mike McQuaid 已提交
84

Mike McQuaid's avatar
Mike McQuaid 已提交
85
Our macOS continuous integration infrastructure is hosted by [MacStadium's Orka](https://www.macstadium.com/customers/homebrew).
Mike McQuaid's avatar
Mike McQuaid 已提交
86

87
[![Powered by MacStadium](https://cloud.githubusercontent.com/assets/125011/22776032/097557ac-eea6-11e6-8ba8-eff22dfd58f1.png)](https://www.macstadium.com)
Mike McQuaid's avatar
Mike McQuaid 已提交
88

EricFromCanada's avatar
EricFromCanada 已提交
89
Secure password storage and syncing is provided by [1Password for Teams](https://1password.com/teams/).
Mike McQuaid's avatar
Mike McQuaid 已提交
90

91
[![1Password](https://1password.com/img/redesign/press/logo.c757be5591a513da9c768f8b80829318.svg)](https://1password.com)
Mike McQuaid's avatar
Mike McQuaid 已提交
92

mchao409's avatar
mchao409 已提交
93
Homebrew is a member of the [Software Freedom Conservancy](https://sfconservancy.org).
94

Dominyk Tiller's avatar
Dominyk Tiller 已提交
95
[![Software Freedom Conservancy](https://sfconservancy.org/img/conservancy_64x64.png)](https://sfconservancy.org)
Jonathan Chang's avatar
Jonathan Chang 已提交
96

Jonathan Chang's avatar
Jonathan Chang 已提交
97
Homebrew is generously supported by [Substack](https://github.com/substackinc), [GitHub](https://github.com/githubsponsors), [Randy Reddig](https://github.com/ydnar), [embark-studios](https://github.com/embark-studios), [Realist.ai](https://github.com/RealistAI) and many other users and organisations via [GitHub Sponsors](https://github.com/sponsors/Homebrew).
Jonathan Chang's avatar
Jonathan Chang 已提交
98

Jonathan Chang's avatar
Jonathan Chang 已提交
99
[![Substack](https://github.com/substackinc.png?size=64)](https://github.com/substackinc)[![GitHub](https://github.com/githubsponsors.png?size=64)](https://github.com/githubsponsors)