summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2023-06-26 17:59:10 -0400
committerNick Gerace <nickagerace@gmail.com>2023-06-26 17:59:10 -0400
commit7a6963c01781f6e3483365311e29dbffd9a31c3d (patch)
tree0e83d4b7f79d49a86f5b24957d9ff427de0d3f1c
parent59853b3b0273191d5bf297dd3b43694d5e6a747b (diff)
downloadgfold-7a6963c01781f6e3483365311e29dbffd9a31c3d.zip
Add docs on core brew formulae
- Add docs on core brew forumlae availability and instructions - Split homebrew install into two instructions - Drop Arch badge to match other installation methods Signed-off-by: Nick Gerace <nickagerace@gmail.com>
-rw-r--r--README.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/README.md b/README.md
index 8b06112..59d1e1d 100644
--- a/README.md
+++ b/README.md
@@ -100,19 +100,30 @@ Now, you can update the config file within your repository and include the linki
[![Packaging status](https://repology.org/badge/vertical-allrepos/gfold.svg)](https://repology.org/project/gfold/versions)
-### Homebrew Install (macOS only)
+### Homebrew
-You can use [Homebrew](https://brew.sh) to install the [tap](https://github.com/nickgerace/homebrew-nickgerace/blob/main/Formula/gfold.rb).
+You can use [Homebrew](https://brew.sh) to install `gfold` with a choice of two methods.
+
+#### Core (macOS and Linux)
+
+`gfold` is now available in the [core formulae](https://formulae.brew.sh/formula/gfold)!
+However, you may run into a naming collision on macOS if [coreutils](https://formulae.brew.sh/formula/coreutils) is installed via `brew`.
+See the [troubleshooting](#troubleshooting-and-known-issues) section for a workaround and more information.
```shell
-brew install nickgerace/nickgerace/gfold
+brew install gfold
```
-_Note:_ the tap may not work with [Linuxbrew](https://docs.brew.sh/Homebrew-on-Linux).
+#### Tap (macOS only)
-### Arch Linux
+The [tap](https://github.com/nickgerace/homebrew-nickgerace/blob/main/Formula/gfold.rb) is still available if you would like to use it.
+This is subject to change.
-[![arch linux](https://img.shields.io/archlinux/v/extra/x86_64/gfold?logo=archlinux&logoColor=white&style=flat-square&color=blue)](https://archlinux.org/packages/extra/x86_64/gfold/)
+```shell
+brew install nickgerace/nickgerace/gfold
+```
+
+### Arch Linux
You can use [pacman](https://wiki.archlinux.org/title/Pacman) to install `gfold` from the [Extra repository](https://archlinux.org/packages/extra/x86_64/gfold/).
@@ -134,7 +145,7 @@ If you are using [flakes](https://nixos.wiki/wiki/Flakes), you can install using
nix profile install "nixpkgs#gfold"
```
-### Cargo Install
+### Cargo
You can use [cargo](https://crates.io) to install the [crate](https://crates.io/crates/gfold) on almost any platform.