diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..4e95db81b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,33 @@ +# 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](/.github/CONTRIBUTING.md). + +### Community Forums +- [@MacHomebrew](https://twitter.com/MacHomebrew) +- [homebrew-discuss@googlegroups.com](mailto:homebrew-discuss@googlegroups.com) ([archive](https://groups.google.com/forum/#!forum/homebrew-discuss)) - subscribe by sending a mail to [homebrew-discuss+subscribe@googlegroups.com](mailto:homebrew-discuss+subscribe@googlegroups.com) +- [freenode.net\#machomebrew](irc://irc.freenode.net/#machomebrew) + +## Supporters +[A list of the awesome people who gave £5 or more to our +Kickstarter](./Kickstarter-Supporters.md). |