mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add cask instructions to tap docs

Browse Source 
Loosely based on (now deleted) 4c72606867/doc/alternate_cask_taps.md
Cask naming issues are from experimentation.
This commit is contained in:
Thomas Andrew 2019-10-05 13:27:17 +01:00
parent fd9a09e18f
commit 7855bb88b6
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/How-to-Create-and-Maintain-a-Tap.md
View File

@ -1,7 +1,7 @@
# How to Create and Maintain a Tap # How to Create and Maintain a Tap
[Taps](Taps.md) are external sources of Homebrew formulae and/or external commands. They [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 and/or external commands can be created by anyone to provide their own formulae, casks and/or external commands
to any Homebrew user. to any Homebrew user.
## Creating a tap ## 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 update`. Outdated formulae will be upgraded when a user runs
`brew upgrade`, like core formulae. `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 ## External commands
You can provide your tap users with custom `brew` commands by adding them in a You can provide your tap users with custom `brew` commands by adding them in a