Skip to content

Commit

Permalink
README fix ups
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mxcl committed Jul 29, 2011
1 parent 7e7a8dc commit 9a4e00f
Showing 1 changed file with 11 additions and 42 deletions.
53 changes: 11 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 9a4e00f

Please sign in to comment.