From 7855bb88b6d25b34b43b56f5373e8830565645e6 Mon Sep 17 00:00:00 2001 From: Thomas Andrew Date: Sat, 5 Oct 2019 13:27:17 +0100 Subject: [PATCH] Add cask instructions to tap docs Loosely based on (now deleted) https://github.com/Homebrew/homebrew-cask/blob/4c72606867d7aa92987c550082769d0f20e6121c/doc/alternate_cask_taps.md Cask naming issues are from experimentation. --- docs/How-to-Create-and-Maintain-a-Tap.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/How-to-Create-and-Maintain-a-Tap.md b/docs/How-to-Create-and-Maintain-a-Tap.md index 82d06ad821..e70d803145 100644 --- a/docs/How-to-Create-and-Maintain-a-Tap.md +++ b/docs/How-to-Create-and-Maintain-a-Tap.md @@ -1,7 +1,7 @@ # How to Create and Maintain a Tap -[Taps](Taps.md) are external sources of Homebrew formulae and/or external commands. They -can be created by anyone to provide their own formulae and/or external commands +[Taps](Taps.md) are external sources of Homebrew formulae, casks and/or external commands. They +can be created by anyone to provide their own formulae, casks and/or external commands to any Homebrew user. ## Creating a tap @@ -58,6 +58,19 @@ Once your tap is installed, Homebrew will update it each time a user runs `brew update`. Outdated formulae will be upgraded when a user runs `brew upgrade`, like core formulae. +## Casks + +Casks can also be installed from a tap. +Casks can be included in taps with formulae, or in a tap with just casks. +Place any cask files you wish to make available in a `Casks` directory at the top level of your tap. + +See [homebrew/cask](https://github.com/Homebrew/homebrew-cask) for an example of a tap with a `Casks` subdirectory. + +### Naming + +Unlike formulae, casks must have globally unique names to avoid clashes. +This can be achieved by e.g. prepending the cask name with you github username: `username-formula-name`. + ## External commands You can provide your tap users with custom `brew` commands by adding them in a