Docs: Homebrew installation instructions (#1129)

emmercm · May 10, 2024 · 362aaae · 362aaae
1 parent 6b9a0cc
commit 362aaae
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/docs/dats/processing.md b/docs/dats/processing.md
@@ -132,6 +132,6 @@ Super Smash Bros. Melee (USA) (En,Ja) (Rev 2)
 
 !!! tip
 
-    [Retool](https://github.com/unexpectedpanda/retool) is a DAT manipulation tool that has a set of hand-maintained [parent/clone lists](https://github.com/unexpectedpanda/retool-clonelists-metadata) to supplement common DAT groups such as No-Intro and Redump. This helps cover situations such as release titles in different languages that would be hard to group together automatically.
+    [Retool](https://github.com/unexpectedpanda/retool) (no longer maintained) is a DAT manipulation tool that has a set of hand-maintained [parent/clone lists](https://github.com/unexpectedpanda/retool-clonelists-metadata) to supplement common DAT groups such as No-Intro and Redump. This helps cover situations such as release titles in different languages that would be hard to group together automatically.
 
     1G1R DATs made by Retool can be used seamlessly with `igir`. You won't need to supply the `--single` option or any [ROM preferences](../roms/filtering-preferences.md) for `igir`, as you would have already applied these preferences in Retool, but you can still supply [ROM filtering](../roms/filtering-preferences.md) options if desired.
diff --git a/docs/input/reading-archives.md b/docs/input/reading-archives.md
@@ -34,4 +34,4 @@ This is why `igir` uses `.zip` as its output archive of choice, `.zip` files are
 
 It can be expensive to calculate checksums of files within archives, especially MD5, SHA1, and SHA256. If `igir` needs to calculate a checksum that is not easily read from the archive (see above), it will cache the result in a file named `igir.cache`. This cached result will then be used as long as the input file's size and modified timestamp remain the same.
 
-Caching can be disabled with the `--disable-cache` option, or you can safely delete `igir.cache` if it becomes too large.
+The location of this cache file can be controlled with the `--cache-path <path>` option, or caching can be disabled entirely with the `--disable-cache` option. You can safely delete `igir.cache` when `igir` isn't running if the file becomes too large for you.
diff --git a/docs/installation.md b/docs/installation.md
@@ -47,6 +47,25 @@ npx igir@latest copy extract --dat *.dat --input ROMs/ --output ROMs-Sorted/ --d
     npm exec --yes -- "github:emmercm/igir#main" [commands..] [options]
     ```
 
+## Via Homebrew (macOS)
+
+[Homebrew](https://brew.sh/) is third-party package manager for macOS. You can install `igir` with these simple commands:
+
+```shell
+brew tap emmercm/igir
+brew install igir
+```
+
+You can then update `igir` with _either_ of these commands
+
+```shell
+# Update every Homebrew package
+brew update
+
+# Update only igir
+brew upgrade igir
+```
+
 ## Via downloaded executable
 
 [![GitHub: release](https://img.shields.io/github/v/release/emmercm/igir?color=%236e5494&logo=github&logoColor=white)](https://github.com/emmercm/igir/releases/latest)