
Remove duplication, link to the API documentation more often, tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s and `@adamv`'s significant past contributions to Homebrew, delete some outdated or unneeded documentation, add some missing `Formula` API. entries and simplify/improve `CONTRIBUTING.md`. Closes Homebrew/homebrew#46179. Closes Homebrew/homebrew#46618. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# README
|
||
Homebrew installs the stuff you need that Apple didn’t.
|
||
|
||
- [Install Homebrew](Installation.md)
|
||
- [Frequently Asked Questions](FAQ.md)
|
||
- [Tips and Tricks](Tips-N'-Tricks.md)
|
||
- [Gems, Eggs and Perl Modules](Gems,-Eggs-and-Perl-Modules.md)
|
||
- [Homebrew and Python](Homebrew-and-Python.md)
|
||
|
||
Please note: Homebrew is not 1.0 yet. Generally it works well, but when
|
||
it doesn’t we’d hope you report the bug.
|
||
## Troubleshooting
|
||
First, please run `brew update` (twice) and `brew doctor`.
|
||
|
||
Second, please read the [Troubleshooting Checklist](Troubleshooting.md).
|
||
|
||
**If you don’t follow these steps it will take us far longer to help you with
|
||
your problem.**
|
||
|
||
However! Fixing build issues is easier than you think: try
|
||
`brew edit $FORMULA` and see how you fare.
|
||
|
||
## Contributing
|
||
Read [CONTRIBUTING.md](/CONTRIBUTING.md).
|
||
|
||
### Community Forums
|
||
- [@MacHomebrew](https://twitter.com/MacHomebrew)
|
||
- [homebrew@librelist.com](mailto:homebrew@librelist.com) ([archive](http://librelist.com/browser/homebrew))
|
||
- [freenode.net\#machomebrew](irc://irc.freenode.net/#machomebrew)
|
||
|
||
## Supporters
|
||
[A list of the awesome people who gave £5 or more to our
|
||
Kickstarter](https://github.com/Homebrew/homebrew/blob/master/SUPPORTERS.md).
|