mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/README.md

34 lines
1.3 KiB
Markdown
Raw Normal View History

Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
# README
Homebrew installs the stuff you need that Apple didn’t.
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
- [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)
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
Please note: Homebrew is not 1.0 yet. Generally it works well, but when
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
it doesn’t we’d hope you report the bug.
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
## Troubleshooting
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
First, please run `brew update` (twice) and `brew doctor`.
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
Second, please read the [Troubleshooting Checklist](Troubleshooting.md).
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
**If you don’t follow these steps it will take us far longer to help you with
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
your problem.**
However! Fixing build issues is easier than you think: try
`brew edit $FORMULA` and see how you fare.
## Contributing
doc/homebrew/README: update CONTRIBUTING path
2016-02-17 22:38:48 +00:00
Read [CONTRIBUTING.md](/.github/CONTRIBUTING.md).
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
### Community Forums
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
- [@MacHomebrew](https://twitter.com/MacHomebrew)
Add directions for subscribing to mailing list Closes Homebrew/homebrew#48369. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-01-22 15:35:37 +01:00
- [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)
Overhaul, simplify and cleanup documentation. 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>
2015-12-06 22:18:16 +00:00
- [freenode.net\#machomebrew](irc://irc.freenode.net/#machomebrew)
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
## Supporters
[A list of the awesome people who gave £5 or more to our
share/doc/homebrew/README: fix supporters link. The link to the Kickstarter Supporters file was broken. This new link points to the ./Kickstarter-Supporters.md file. Closes Homebrew/homebrew#50335. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-03-22 21:31:47 -04:00
Kickstarter](./Kickstarter-Supporters.md).
Reference in New Issue Copy Permalink