Skip to content

Commit

Permalink
Suggest use of the github gem when contributing
Browse files Browse the repository at this point in the history
Remove the lame beer related FAQs that make me look like an alcoholic.
  • Loading branch information
mxcl committed Oct 15, 2009
1 parent 692931b commit 202b95a
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,11 @@ Contributing New Formulae
=========================
Formulae are simple Ruby scripts. Generate a formula with most bits filled-in:

brew create http://foo.org/foobar-1.2.1.tar.bz2
brew create http://example.com/foo-1.2.1.tar.bz2

Check it over and try to install it:

brew install foobar
brew install foo

Check the [wiki][] for more detailed information and tips for contribution.

Expand All @@ -288,6 +288,15 @@ If you want your formula to become part of this distribution, fork
maintain your own distribution. Maybe you want to support Tiger? Or use
special compile flags? Go ahead that's what git is all about! :)

The easiest way to fork is with the [github-gem][], so potentially this is
your workflow:

brew create http://example.com/foo-1.2.1.tar.bz2
git commit Library/Formula/foo.rb
github fork
git push myname master
github pull-request


Licensing
=========
Expand All @@ -297,20 +306,16 @@ confirm. Individual formulae are licensed according to their authors' wishes.

FAQ
===
1. Are you excessively interested in beer?
Yes.

2. Was Homebrew devised under the influence of alcohol?
Yes.

3. Can Homebrew replace MacPorts?
1. Can Homebrew replace MacPorts?
Maybe. But remember, Homebrew is still incomplete. Be forgiving in your
approach and be willing to fork and contribute fixes. Thanks!

4. Is there an IRC channel?
2. Is there an IRC channel?
Yes, <irc://irc.freenode.net#machomebrew>.

5. And it's on Twitter?
3. And it's on Twitter?
Yes, <http://twitter.com/machomebrew>.


[wiki]: http://wiki.github.com/mxcl/homebrew
[github-gem]: http://github.com/defunkt/github-gem

0 comments on commit 202b95a

Please sign in to comment.