From f0960c8d1b699879237f5daf610e1a517f91f449 Mon Sep 17 00:00:00 2001 From: Bjerg Date: Mon, 14 Aug 2023 14:20:55 +0200 Subject: [PATCH] docs: document updating formula --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd723f7..4168dfe 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ -## How do I install these formulae? +## Paradigm Brew Formulae -`brew install paradigmxyz/brew/` +Homebrew formulae and casks for various Paradigm software. -Or `brew tap paradigmxyz/brew` and then `brew install `. +### How do I install these formulae? -## Documentation +Either install directly using `brew install paradigmxyz/brew/`, or add the tap first `brew tap paradigmxyz/brew` and then use `brew install `. -`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