shen/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2024-11-25 16:33:34 +08:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity
master
brew/README.md

93 lines
8.6 KiB
Markdown
Raw Permalink Normal View History

Cleanup root documentation.
2014-10-26 23:23:42 +08:00
# Homebrew
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
README: add some more shields. For the current release, Travis CI and Coveralls status.
2017-03-23 17:35:19 +08:00
[![GitHub release](https://img.shields.io/github/release/Homebrew/brew.svg)](https://github.com/Homebrew/brew/releases)
README: use docs.brew.sh link.
2018-02-23 22:51:08 +08:00
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).
readme - how to find packages
2010-10-22 00:34:54 +08:00
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
## What Packages Are Available?
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Remove outdated `brew search` reference from README
2021-04-10 04:29:19 +08:00
1. Type `brew formulae` for a list.
Updated URL to use HTTPS instead of HTTP Updated URL to use HTTPS instead of HTTP to avoid redirect
2018-05-22 04:20:49 +08:00
2. Or visit [formulae.brew.sh](https://formulae.brew.sh) to browse packages online.
readme - how to find packages
2010-10-22 00:34:54 +08:00
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
## More Documentation
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Use https for all docs.brew.sh links. May as well use the more secure link when possible.
2017-07-27 22:59:37 +08:00
`brew help`, `man brew` or check [our documentation](https://docs.brew.sh/).
Change license to BSD I confirmed this change with all relevant contributors first.
2009-08-31 23:01:36 +08:00
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
## Troubleshooting
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
README: add troubleshooting.
2014-01-19 06:31:20 +08:00
First, please run `brew update` and `brew doctor`.
Use more docs.brew.sh short links These are nicer on the eyes.
2018-02-23 03:46:58 +08:00
Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting).
README: add troubleshooting.
2014-01-19 06:31:20 +08:00
**If you don't read these it will take us far longer to help you with your problem.**
README: rearrange. Let's put things users are more likely to care about nearer the top.
2023-02-16 21:27:43 +08:00
## Donations
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.
Please consider a regular donation through [GitHub Sponsors](https://github.com/sponsors/Homebrew), [Open Collective](https://opencollective.com/homebrew) or [Patreon](https://www.patreon.com/homebrew). Homebrew is fiscally hosted by the [Open Source Collective](https://opencollective.com/opensource).
README: use PLC email for corporate donors.
2024-02-02 00:02:08 +08:00
For questions about donations, including corporate giving, please email the Homebrew PLC at [plc@brew.sh](mailto:plc@brew.sh).
Point corporate donors toward our OC contact form A corporate donor recently wasn't able to find a clear way to contact a Homebrew person to talk about a possible donation. They eventually found the OC contact us page, which is the best way to contact the PLC short without having a GitHub account and posting on an issue or Discussions. Let's highlight the donations questions contact form specifically in this area that is the landing target for the donations link on https://brew.sh.
2024-02-01 10:15:13 +08:00
README: rearrange. Let's put things users are more likely to care about nearer the top.
2023-02-16 21:27:43 +08:00
## Community
- [Homebrew/discussions (forum)](https://github.com/orgs/Homebrew/discussions)
- [@homebrew@fosstodon.org (Mastodon)](https://fosstodon.org/@homebrew)
Update README
2024-09-07 00:34:57 +08:00
- [@MacHomebrew (𝕏 (formerly known as Twitter))](https://x.com/MacHomebrew)
README: rearrange. Let's put things users are more likely to care about nearer the top.
2023-02-16 21:27:43 +08:00
README: add Contributing section. Also, explicitly welcome new/beginner contributors and give them a suggested starting point to contribute to Homebrew. Based on the boiler plate I tend to send people to for GSoC, Outreachy or generally people who say "I want to try and contribute to open-source".
2016-07-27 10:07:04 +08:00
## Contributing
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Refer to default branch in links with HEAD Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This will make life easier if we ever rename our default branch in future (once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 18:20:57 +08:00
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).
README: add Contributing section. Also, explicitly welcome new/beginner contributors and give them a suggested starting point to contribute to Homebrew. Based on the boiler plate I tend to send people to for GSoC, Outreachy or generally people who say "I want to try and contribute to open-source".
2016-07-27 10:07:04 +08: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.
docs: various additions & changes
2023-09-05 12:58:57 +08:00
A good starting point for contributing is to first [tap `homebrew/core`](https://docs.brew.sh/FAQ#can-i-edit-formulae-myself), then run `brew audit --strict` with some of the packages you use (e.g. `brew audit --strict wget` if you use `wget`) and 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.
README: tweak contributing, donations sections. - Add links to more stuff people could contribute to - Add back option for one-off donations (fixes #3565).
2017-12-12 21:58:43 +08:00
Change `labeled` to `labelled` for a consistent BE-style
2023-10-31 00:03:48 +08:00
Alternatively, for something more substantial, check out one of the issues labelled `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).
README: tweak contributing, donations sections. - Add links to more stuff people could contribute to - Add back option for one-off donations (fixes #3565).
2017-12-12 21:58:43 +08:00
Good luck!
README: add Contributing section. Also, explicitly welcome new/beginner contributors and give them a suggested starting point to contribute to Homebrew. Based on the boiler plate I tend to send people to for GSoC, Outreachy or generally people who say "I want to try and contribute to open-source".
2016-07-27 10:07:04 +08:00
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
## Security
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
README: Better words for what the security form is Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2022-11-10 19:22:02 +08:00
Please report security issues by filling in [the security advisory form](https://github.com/homebrew/brew/security/advisories/new).
README: add PGP key Closes Homebrew/homebrew#40914. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-06-20 17:54:54 +08:00
Readme: tweak wording Who Are You? -> Who We Are
2020-06-01 19:50:34 +08:00
## Who We Are
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Fixed "Project Leader" link
2019-12-03 00:43:25 +08:00
Homebrew's [Project Leader](https://docs.brew.sh/Homebrew-Governance#6-project-leader) is [Mike McQuaid](https://github.com/MikeMcQuaid).
README: add lead, new maintainers.
2016-09-20 16:30:42 +08:00
Update maintainers. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-02-05 20:07:42 +08:00
Homebrew's [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee) is [Colin Dean](https://github.com/colindean), [Issy Long](https://github.com/issyl0), [Mike McQuaid](https://github.com/MikeMcQuaid), [Patrick Linnane](https://github.com/p-linnane) and [Vanessa Gennarelli](https://github.com/mozzadrella).
Add the SFC PLC to the README and manpage. Let's document these so people know who the leadership team behind the project is.
2018-08-02 20:26:02 +08:00
Update maintainers. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2023-04-11 17:33:36 +08:00
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).
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
Update manpage and completions. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-10-25 08:07:57 +08:00
Homebrew's maintainers are [Alexander Bayandin](https://github.com/bayandin), [Bevan Kay](https://github.com/bevanjkay), [Bo Anderson](https://github.com/Bo98), [Branch Vincent](https://github.com/branchvincent), [Caleb Xu](https://github.com/alebcay), [Carlo Cabrera](https://github.com/carlocab), [Daeho Ro](https://github.com/daeho-ro), [Douglas Eichelberger](https://github.com/dduugg), [Dustin Rodrigues](https://github.com/dtrodrigues), [Eric Knibbe](https://github.com/EricFromCanada), [FX Coudert](https://github.com/fxcoudert), [Issy Long](https://github.com/issyl0), [Justin Krehel](https://github.com/krehel), [Klaus Hipp](https://github.com/khipp), [Markus Reiter](https://github.com/reitermarkus), [Michael Cho](https://github.com/cho-m), [Michka Popoff](https://github.com/iMichka), [Mike McQuaid](https://github.com/MikeMcQuaid), [Nanda H Krishna](https://github.com/nandahkrishna), [Patrick Linnane](https://github.com/p-linnane), [Rui Chen](https://github.com/chenrui333), [Ruoyu Zhong](https://github.com/ZhongRuoyu), [Rylan Polster](https://github.com/Rylan12), [Sam Ford](https://github.com/samford), [Sean Molenaar](https://github.com/SMillerDev), [Thierry Moisan](https://github.com/Moisan), [Timothy Sutton](https://github.com/timsutton), [William Woodruff](https://github.com/woodruffw) and [Štefan Baebler](https://github.com/stefanb).
Add new maintainers Also add some who were missing (sorry folks) and our Linux maintainers.
2018-08-07 17:51:16 +08:00
Update README.md and manpage
2024-08-30 08:44:31 +08:00
Former maintainers with significant contributions include [Miccal Matthews](https://github.com/miccal), [Misty De Méo](https://github.com/mistydemeo), [Shaun Jackman](https://github.com/sjackman), [Vítor Galvão](https://github.com/vitorgalvao), [Claudia Pellegrino](https://github.com/claui), [Seeker](https://github.com/SeekingMeaning), [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).
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 18:53:21 +08:00
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
## License
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Shorten some links in README.md
2018-04-25 06:02:39 +08:00
Code is under the [BSD 2-clause "Simplified" License](LICENSE.txt).
README: note documentation license.
2015-10-13 19:04:38 +08:00
Documentation is under the [Creative Commons Attribution license](https://creativecommons.org/licenses/by/4.0/).
Cleanup root documentation.
2014-10-26 23:23:42 +08:00
README: add sponsors.
2015-02-23 22:20:12 +08:00
## Sponsors
README: update TSC, fix linting. - Add the new TSC to the README, manpage - Fix linting complaints about whitespace in the README
2021-03-15 23:08:54 +08:00
Remove last Jenkins references - remove Jenkins Testing support from `brew pull` - update reference to MacStadium Orka - remove reference to DigitalOcean
2020-04-19 21:53:18 +08:00
Our macOS continuous integration infrastructure is hosted by [MacStadium's Orka](https://www.macstadium.com/customers/homebrew).
README: add sponsors.
2015-02-23 22:20:12 +08:00
README: note MacStadium, add more links.
2017-02-09 17:00:23 +08:00
[![Powered by MacStadium](https://cloud.githubusercontent.com/assets/125011/22776032/097557ac-eea6-11e6-8ba8-eff22dfd58f1.png)](https://www.macstadium.com)
README: add sponsors.
2015-02-23 22:20:12 +08:00
README: update 1Password image
2020-11-03 07:14:34 +08:00
Secure password storage and syncing is provided by [1Password for Teams](https://1password.com/teams/).
README: add 1Password for Teams.
2016-06-02 17:17:40 +08:00
README.md: Normalise 1Password icon size
2023-07-19 07:42:49 +08:00
[<img src="https://i.1password.com/akb/featured/1password-icon.svg" alt="1Password" height="64">](https://1password.com)
README: add 1Password for Teams.
2016-06-02 17:17:40 +08:00
README: add @buildpulse link and logo.
2021-08-23 20:19:42 +08:00
Flaky test detection and tracking is provided by [BuildPulse](https://buildpulse.io/).
README.md: Normalise BuildPulse icon size
2023-07-19 07:47:21 +08:00
[![BuildPulse](https://github.com/Homebrew/brew/assets/1699443/87385e9a-6c47-4e59-b17e-fe083e945709)](https://buildpulse.io)
README: add @buildpulse link and logo.
2021-08-23 20:19:42 +08:00
README: add DNSimple as a sponsor. They've provided our DNS for free for a while so let's give them a shout-out.
2022-01-17 21:35:55 +08:00
<https://brew.sh>'s DNS is [resolving with DNSimple](https://dnsimple.com/resolving/homebrew).
Adapt DNSimple logo to system appearance
2022-01-18 01:36:18 +08:00
[![DNSimple](https://cdn.dnsimple.com/assets/resolving-with-us/logo-light.png)](https://dnsimple.com/resolving/homebrew#gh-light-mode-only)
[![DNSimple](https://cdn.dnsimple.com/assets/resolving-with-us/logo-dark.png)](https://dnsimple.com/resolving/homebrew#gh-dark-mode-only)
README: add DNSimple as a sponsor. They've provided our DNS for free for a while so let's give them a shout-out.
2022-01-17 21:35:55 +08:00
Update sponsors. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-11-15 08:07:47 +08:00
Homebrew is generously supported by [GitHub](https://github.com/github), [Custom Ink](https://github.com/customink), [Randy Reddig](https://github.com/ydnar), [Codecademy](https://github.com/Codecademy), [MacPaw Inc.](https://github.com/MacPaw), [Workbrew](https://github.com/Workbrew) and many other users and organisations via [GitHub Sponsors](https://github.com/sponsors/Homebrew).
Update sponsors. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2023-03-17 08:05:28 +08:00
Update sponsors. Autogenerated by the [sponsors-maintainers-man-completions](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/sponsors-maintainers-man-completions.yml) workflow.
2024-11-15 08:07:47 +08:00
[![GitHub](https://github.com/github.png?size=64)](https://github.com/github)
Reference in New Issue Copy Permalink