From b84ec63ff9d62e00d2546e36fc2c1941f886d923 Mon Sep 17 00:00:00 2001 From: Matt Brender Date: Wed, 12 Oct 2016 21:38:59 -0400 Subject: [PATCH] Further terminology in docs + link on README Addressing a few spots where I looked for terminology and did not find what I was looking for. Input based on a recent [podcast with Mike](https://changelog.com/podcast/223) --- README.md | 2 +- docs/FAQ.md | 3 +++ docs/Formula-Cookbook.md | 6 ++++-- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef72320407..86df31429a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Homebrew -Features, usage and installation instructions are [summarised on the homepage](http://brew.sh). +Features, usage and installation instructions are [summarised on the homepage](http://brew.sh). Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained here](docs/Formula-Cookbook.md#homebrew-terminology). ## Update Bug If Homebrew was updated on Aug 10-11th 2016 and `brew update` always says `Already up-to-date.` you need to run: diff --git a/docs/FAQ.md b/docs/FAQ.md index f13703bdda..3b8fe7de31 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -245,3 +245,6 @@ to with `brew link`. ### How can I specify different configure arguments for a formula? `brew edit $FORMULA` and edit the formula. Currently there is no other way to do this. + +### Is there a glossary of terms around? +All your terminology needs can be [found here](docs/Formula-Cookbook.md#homebrew-terminology). \ No newline at end of file diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 1cf554d03e..950b662aeb 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -9,9 +9,11 @@ A formula is a package definition written in Ruby. It can be created with `brew | **Keg** | The installation prefix of a **Formula** | `/usr/local/Cellar/foo/0.1` | | **opt prefix** | A symlink to the active version of a **Keg** | `/usr/local/opt/foo ` | | **Cellar** | All **Kegs** are installed here | `/usr/local/Cellar` | -| **Tap** | An optional Git repository of **Formulae** and/or commands | `/usr/local/Homebrew/Library/Taps/homebrew/homebrew-versions` | +| **Tap** | An optional Git repository of **Formulae** and/or commands | `/usr/local/Homebrew/Library/Taps/homebrew/homebrew-versions` | | **Bottle** | Pre-built **Keg** used instead of building from source | `qt-4.8.4.mavericks.bottle.tar.gz` | - +| **Cask** | An [extension of homebrew](https://github.com/caskroom/homebrew-cask) to install macOS native apps | `/Applications/MacDown.app/Contents/SharedSupport/bin/macdown` | +| **Brew Bundle**| An [extension of homebrew](https://github.com/Homebrew/homebrew-bundle) to describe dependencies | `brew 'myservice', restart_service: true` | + ## An Introduction Homebrew uses Git for downloading updates and contributing to the project.