aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Installation.md
diff options
context:
space:
mode:
authorMike McQuaid2016-09-19 19:58:21 +0100
committerMike McQuaid2016-09-20 10:41:42 +0100
commitbd6fb88ddc72a0de4c27f65e60a82790a5d87f3f (patch)
tree4a40854293dc41c0184f5532583a864712aa5b8c /docs/Installation.md
parentf87e3626bb241bc88bead4ed6448a76c1bf49f56 (diff)
downloadbrew-bd6fb88ddc72a0de4c27f65e60a82790a5d87f3f.tar.bz2
Rearrange repository files.
Diffstat (limited to 'docs/Installation.md')
-rw-r--r--docs/Installation.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/Installation.md b/docs/Installation.md
new file mode 100644
index 000000000..8ee1891cf
--- /dev/null
+++ b/docs/Installation.md
@@ -0,0 +1,57 @@
+# Installation
+The suggested and easiest way to install Homebrew is on the
+[homepage](http://brew.sh).
+
+The standard script installs Homebrew to `/usr/local` so that
+[you don’t need sudo](FAQ.md#why-does-homebrew-say-sudo-is-bad-) when you
+`brew install`. It is a careful script, it can be run even if you have stuff
+installed to `/usr/local` already. It tells you exactly what it will do before
+it does it too. And you have to confirm everything it will do before it starts.
+
+## Requirements
+* An Intel CPU <sup>[1](#1)</sup>
+* OS X 10.10 or higher <sup>[2](#2)</sup>
+* Command Line Tools for Xcode: `xcode-select --install`,
+ https://developer.apple.com/downloads or
+ [Xcode](https://itunes.apple.com/us/app/xcode/id497799835) <sup>[3](#3)</sup>
+* A Bourne-compatible shell for installation (e.g. bash or zsh) <sup>[4](#4)</sup>
+
+## Alternative Installs
+### Untar anywhere
+Just extract (or `git clone`) Homebrew wherever you want. Just
+avoid:
+
+* Directories with names that contain spaces. Homebrew itself can handle spaces, but many build scripts cannot.
+* `/sw` and `/opt/local` because build scripts get confused when Homebrew is there instead of Fink or MacPorts, respectively.
+
+However do yourself a favor and install to `/usr/local`. Some things may
+not build when installed elsewhere. One of the reasons Homebrew just
+works relative to the competition is **because** we recommend installing
+to `/usr/local`. *Pick another prefix at your peril!*
+
+`mkdir homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C homebrew`
+
+### Multiple installations
+Create a Homebrew installation wherever you extract the tarball. Whichever brew command is called is where the packages will be installed. You can use this as you see fit, e.g. a system set of libs in `/usr/local` and tweaked formulae for development in `~/homebrew`.
+
+## Uninstallation
+Uninstallation is documented in the [FAQ](FAQ.md).
+
+<a name="1"><sup>1</sup></a> Not all formulae have CPU or OS requirements, but
+you can assume you will have trouble if you don’t conform. Also, you can find
+PowerPC and Tiger branches from other users in the fork network. See
+[Interesting Taps & Forks](Interesting-Taps-&-Forks.md).
+
+<a name="2"><sup>2</sup></a> 10.10 or higher is recommended. 10.5 - 10.8 are
+supported on a best-effort basis. For 10.4 and 10.5, see
+[Tigerbrew](https://github.com/mistydemeo/tigerbrew).
+
+<a name="3"><sup>3</sup></a> Most formulae require a compiler. A handful
+require a full Xcode installation. You can install Xcode, the CLT, or both;
+Homebrew supports all three configurations. Downloading Xcode may require an
+Apple Developer account on older versions of Mac OS X. Sign up for free
+[here](https://developer.apple.com/register/index.action).
+
+<a name="4"><sup>4</sup></a> The one-liner installation method found on
+[brew.sh](http://brew.sh) requires a Bourne-compatible shell (e.g. bash or
+zsh). Notably, fish, tcsh and csh will not work.