Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation and Linuxbrew documentation #5623

Merged
merged 1 commit into from
Jan 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Installation

The suggested and easiest way to install Homebrew is on the
The supported and best way to install Homebrew is on the
[homepage](https://brew.sh).

The standard script installs Homebrew to `/usr/local` so that
This 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.
it does it too. You have to confirm everything it will do before it starts.

## Requirements
## macOS Requirements
* An 64-bit Intel CPU <sup>[1](#1)</sup>
* macOS 10.12 or higher <sup>[2](#2)</sup>
* macOS 10.12 (or higher) <sup>[2](#2)</sup>
* Command Line Tools (CLT) for Xcode: `xcode-select --install`,
[developer.apple.com/downloads](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>
* A Bourne-compatible shell for installation (e.g. `bash` or `zsh`) <sup>[4](#4)</sup>

## Alternative Installs

### OS X Mountain Lion (10.8) and below
Because GitHub now only allows clients that support TLS 1.2 to access repositories over HTTPS, the Homebrew installer will use the Git protocol when run on systems older than OS X Mavericks (10.9). This requires the availability of a `git` binary, which can be provided by pre-installing the [Command Line Tools for Xcode](https://developer.apple.com/download/more/). Homebrew will also require the Command Line Tools or Xcode in order to automatically compile and install a newer `curl` and `git` with support for TLS 1.2.
### Linux or Windows 10 Subsystem for Linux

Check out [the Linuxbrew installation documentation](Linuxbrew.md).

### Untar anywhere
Just extract (or `git clone`) Homebrew wherever you want. Just avoid:
Expand Down
8 changes: 4 additions & 4 deletions docs/Linuxbrew.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Linuxbrew

The Homebrew package manager may be used on Linux and Windows 10, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about). Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory, in which case it does not use *sudo*. Linuxbrew does not use any libraries provided by your host system, except *glibc* and *gcc* if they are new enough. Linuxbrew can install its own current versions of *glibc* and *gcc* for older distribution of Linux.
The Homebrew package manager may be used on Linux and Windows 10, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about). Homebrew is referred to as Linuxbrew when running on Linux or WSL. It can be installed in your home directory, in which case it does not use *sudo*. Linuxbrew does not use any libraries provided by your host system, except *glibc* and *gcc* if they are new enough. Linuxbrew can install its own current versions of *glibc* and *gcc* for older distributions of Linux.

[Features](#features), [dependencies](#dependencies) and [installation instructions](#install) are described below. Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained in the documentation](Formula-Cookbook.md#homebrew-terminology).

Expand Down Expand Up @@ -40,12 +40,12 @@ brew install hello

If you're using an older distribution of Linux, installing your first package will also install a recent version of `glibc` and `gcc`. Use `brew doctor` to troubleshoot common issues.

## Dependencies
## Linux/WSL Requirements

+ **GCC** 4.4 or newer
+ **Linux** 2.6.32 or newer
+ **Glibc** 2.12 or newer
+ **64-bit x86** CPU
+ **64-bit x86_64** CPU

Paste at a terminal prompt:

Expand All @@ -71,7 +71,7 @@ Linuxbrew does not currently support 32-bit x86 platforms. It would be possible

## Alternative Installation

Extract or `git clone` Linuxbrew wherever you want. Use `/home/linuxbrew/.linuxbrew` if possible.
Extract or `git clone` Linuxbrew wherever you want. Use `/home/linuxbrew/.linuxbrew` if possible (to enabled the use of binary packages).

```sh
git clone https://github.com/Homebrew/brew ~/.linuxbrew/Homebrew
Expand Down