Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,35 @@ To upgrade to the latest version:
brew upgrade pj
```

> **Known issue**: Homebrew 6.0.x currently has a locking bug
> ([Homebrew/brew#22948](https://github.com/Homebrew/brew/issues/22948)) that
> can make `brew upgrade pj` (and `brew reinstall pj`) fail with
> `Error: A process has already locked ...` for source-built tap formulae,
> even when no other brew process is running. Until the fix ships in Homebrew,
> upgrade with:
>
> ```bash
> brew uninstall pj && brew install pj
> ```

### Upgrading from a cask install

Prior to v1.0.0, `pj` was distributed as a Homebrew **cask**. It is now
distributed as a Homebrew **formula**. The tap includes a migration mapping
(`tap_migrations.json`), so the switch happens automatically on the next
upgrade (the `brew trust` step is required on Homebrew 6+, even if you tapped
before upgrading to it; skip it on brew < 5.1.15, where the command does not
exist):
(`tap_migrations.json`): when you run `brew update`, Homebrew detects the
removed cask and installs the `pj` formula automatically. It does **not**
remove the old cask, whose binary still owns `pj` on your PATH, so two more
commands complete the migration:

```bash
brew trust kevdoran/tap
brew update && brew upgrade pj
brew trust kevdoran/tap # Homebrew 6+ (skip on brew < 5.1.15)
brew update # installs the pj formula automatically
brew uninstall --cask pj # remove the old cask (still owns the pj binary)
brew link pj # activate the formula's pj
```

Verify with `pj version` — it should report the new version.

## Binary download

Grab the latest release from [GitHub Releases](https://github.com/kevdoran/projector/releases), extract the archive, and move `pj` to a directory on your PATH:
Expand Down
Loading