Skip to content
Snippets Groups Projects
Unverified Commit 70f232ad authored by Mike McQuaid's avatar Mike McQuaid Committed by GitHub
Browse files

Merge pull request #6537 from tomjonandy/docs/cask-tap

Docs: Add cask instructions to tap docs
parents 9e56a862 7855bb88
No related branches found
No related tags found
No related merge requests found
# 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
......@@ -61,6 +61,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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment