From 6ad2907000d927e055cacf389228ebdc01fcc0d7 Mon Sep 17 00:00:00 2001 From: Max Howell Date: Thu, 15 Oct 2009 09:09:01 +0100 Subject: [PATCH] Suggest use of the github gem when contributing Remove the lame beer related FAQs that make me look like an alcoholic. --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5dab7edfba..2afc60ccd1 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 ========= @@ -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, . -5. And it's on Twitter? +3. And it's on Twitter? Yes, . + [wiki]: http://wiki.github.com/mxcl/homebrew +[github-gem]: http://github.com/defunkt/github-gem