-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from paradigmxyz/onbjerg/docs
docs: document updating formula
- Loading branch information
Showing
1 changed file
with
11 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,15 @@ | ||
## How do I install these formulae? | ||
## Paradigm Brew Formulae | ||
|
||
`brew install paradigmxyz/brew/<formula>` | ||
Homebrew formulae and casks for various Paradigm software. | ||
|
||
Or `brew tap paradigmxyz/brew` and then `brew install <formula>`. | ||
### How do I install these formulae? | ||
|
||
## Documentation | ||
Either install directly using `brew install paradigmxyz/brew/<formula>`, or add the tap first `brew tap paradigmxyz/brew` and then use `brew install <formula>`. | ||
|
||
`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh). | ||
### How do I update the formulae? | ||
|
||
1. Open a PR, changing the tag and revision as appropriate (revision should point to the tagged commit) | ||
2. Wait for CI to finish | ||
3. Add the `pr-pull` label, which will do a bunch of housekeeping for you and merge the PR[^1] | ||
|
||
[^1]: The PR will be closed |