From cd4337f91711ca4db134f784c625351603ebc288 Mon Sep 17 00:00:00 2001 From: Max Howell Date: Thu, 7 Jul 2011 18:06:11 +0100 Subject: [PATCH] README fix ups The point being to have less duplicate information. I am updating the wiki and the homepage accordingly. I am loathe to leave the "what packages are available" lines but I believe people who are interested in such things are likely to end up at the source root so it is appropriate. --- README.md | 53 +++++++++++------------------------------------------ 1 file changed, 11 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 293fae3878..3c17279556 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,23 @@ Homebrew ======== -Features and usage are [summarized on the homepage][homepage]. - - -Quick Install to /usr/local ---------------------------- -[This script][gist] will prompt for confirmation before it does anything: - - /usr/bin/ruby -e "$(curl -fsSL https://raw.github.com/gist/323731)" - -Afterwards, [install Xcode][xcode]. - - -Umm… I thought I could install it anywhere? -------------------------------------------- -Indeed, you can. Refer to our [complete installation instructions][install]. - - -Dude! Just give me a one-liner! -------------------------------- -Okay then, but please note this installs Homebrew as root and -[we recommend against that][sudo]. - - curl -LsSf https://github.com/mxcl/homebrew/tarball/master | sudo /usr/bin/tar xvz -C/usr/local --strip 1 - - -But what packages are available? --------------------------------- -Before installing you can -[browse the Formula folder on GitHub][browse-formulae]. - -After installing, you can use `brew search` to find packages or `brew server` -to browse packages off of a local web server. +Features, usage and installation instructions are [summarized on the homepage][home]. +What Packages Are Available? +---------------------------- +1. You can [browse the Formula folder on GitHub][formula]. +2. Or type `brew search` for a list. +3. Or run `brew server` to browse packages off of a local web server. More Documentation -================== -The [wiki][] is your friend. - +------------------ +`brew help` or `man brew` or check our [wiki][]. Who Are You? -============ +------------ I'm [Max Howell][mxcl] and I'm a splendid chap. -[homepage]:http://mxcl.github.com/homebrew -[gist]:http://gist.github.com/323731 -[xcode]:http://developer.apple.com/technologies/xcode.html -[install]:http://wiki.github.com/mxcl/homebrew/installation -[sudo]:http://wiki.github.com/mxcl/homebrew/installation#sudo +[home]:http://mxcl.github.com/homebrew [wiki]:http://wiki.github.com/mxcl/homebrew [mxcl]:http://twitter.com/mxcl -[browse-formulae]:http://github.com/mxcl/homebrew/tree/master/Library/Formula/ +[formula]:http://github.com/mxcl/homebrew/tree/master/Library/Formula/