diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 69 |
1 files changed, 23 insertions, 46 deletions
@@ -1,57 +1,34 @@ -Homebrew -======== -Features, usage and installation instructions are [summarized on the homepage][home]. +# Homebrew +Features, usage and installation instructions are [summarised on the homepage](http://brew.sh). -What Packages Are Available? ----------------------------- -1. You can [browse the Formula directory on GitHub][formula]. +## What Packages Are Available? +1. You can [browse the Formula directory on GitHub](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/). 2. Or type `brew search` for a list. -3. Or visit [braumeister.org][braumeister] to browse packages online. -4. Or use [`brew desc`][brew-desc] to browse packages from the command line. +3. Or visit [braumeister.org](http://braumeister.org) to browse packages online. +4. Or use [`brew desc`](https://github.com/telemachus/homebrew-desc) to browse packages from the command line. -More Documentation ------------------- -`brew help` or `man brew` or check our [documentation][]. +## More Documentation +`brew help` or `man brew` or check our [documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme). -Troubleshooting ---------------- +## 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). +Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/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.** -Security --------- +## Security Please report security issues to security@brew.sh. -Who Are You? ------------- -Homebrew's current maintainers are [Misty De Meo][mistydemeo], [Adam Vandenberg][adamv], [Jack Nagel][jacknagel], [Mike McQuaid][mikemcquaid], [Brett Koonce][asparagui] and [Tim Smith][tdsmith]. - -Homebrew was originally created by [Max Howell][mxcl]. - -License -------- -Code is under the [BSD 2 Clause (NetBSD) license][license]. - -Donations ---------- -We accept tips through [Gittip][tip]. - -[](https://www.gittip.com/Homebrew/) - -[home]:http://brew.sh -[documentation]:https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/ -[mistydemeo]:https://github.com/mistydemeo -[adamv]:https://github.com/adamv -[jacknagel]:https://github.com/jacknagel -[mikemcquaid]:https://github.com/mikemcquaid -[asparagui]:https://github.com/asparagui -[tdsmith]:https://github.com/tdsmith -[mxcl]:https://github.com/mxcl -[formula]:https://github.com/Homebrew/homebrew/tree/master/Library/Formula/ -[braumeister]:http://braumeister.org -[brew-desc]: https://github.com/telemachus/homebrew-desc -[license]:https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt -[tip]:https://www.gittip.com/Homebrew/ +## Who Are You? +Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo), [Adam Vandenberg](https://github.com/adamv), [Jack Nagel](https://github.com/jacknagel), [Mike McQuaid](https://github.com/mikemcquaid), [Brett Koonce](https://github.com/asparagui) and [Tim Smith](https://github.com/tdsmith). + +Homebrew was originally created by [Max Howell](https://github.com/mxcl). + +## License +Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt). + +## Donations +We accept tips through [Gratipay](https://gratipay.com/Homebrew/). + +[](https://www.gittip.com/Homebrew/) |