Merge pull request #40 from dezren39/patch-2

Document Declarative Taps
2024-11-12 10:57:35 -07:00
parent b5224d5101 c59b075806
commit d66fc9c14a
1 changed files with 16 additions and 0 deletions
@@ -123,3 +123,19 @@ Extra prefixes may be configured:
 ```

 Note that with a non-standard prefix, you will no longer be able to use most bottles (prebuilt packages).
+
+## Declarative Taps
+
+In Homebrew, the repo part of all taps always have `homebrew-` prepended.
+- https://docs.brew.sh/Taps
+- https://docs.brew.sh/Interesting-Taps-and-Forks
+
+`brew tap <user>/<repo>` makes a clone of the repository at `https://github.com/<user>/homebrew-<repo>` into `$(brew --repository)/Library/Taps`.
+
+When declaring taps, please ensure to name the key as a unique folder starting with `homebrew-`, e.g.:
+```diff
+       nix-homebrew.taps = {
+-        "mtslzr/marmaduke-chromium" = inputs.marmaduke-chromium;
+        "mtslzr/homebrew-marmaduke-chromium" = inputs.marmaduke-chromium;
+```
+The exact GitHub `<user>/<repo>` should almost always work.