From 0e202ff10be2c36d80e9464eda555f6f00819eac Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Tue, 9 Sep 2025 02:18:24 +0100 Subject: [PATCH] docs(readme): update readme Clarify cask list with installation instructions, and also update Apple Silicon information. Resolves #7 --- README.md | 55 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c044d251..0a62baa6 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,15 @@ -

- Homebrew Tap: emacs-builds -

+
-

- Build status - GitHub issues - GitHub pull requests -

+# Homebrew Tap: emacs-builds -

- - Homebrew tap for binary builds of Emacs provided by - jimeh/emacs-builds. - -

+[![Build status](https://img.shields.io/github/actions/workflow/status/jimeh/homebrew-emacs-builds/update-casks.yml?style=flat&label=build&logo=github&logoColor=white)](https://github.com/jimeh/homebrew-emacs-builds/actions) +[![GitHub issues](https://img.shields.io/github/issues-raw/jimeh/homebrew-emacs-builds?style=flat&logo=github)](https://github.com/jimeh/homebrew-emacs-builds/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/jimeh/homebrew-emacs-builds?style=flat&logo=github)](https://github.com/jimeh/homebrew-emacs-builds/pulls) + +*Homebrew tap for binary builds of Emacs provided by +[jimeh/emacs-builds](https://github.com/jimeh/emacs-builds).* + +
## Install Tap @@ -25,12 +21,27 @@ brew tap jimeh/emacs-builds The following Homebrew Casks are provided by this Homebrew Tap: -- `emacs-app` — Latest official release of Emacs. -- `emacs-app-pretest` — Latest pretest build of Emacs based on pretest git tags. -- `emacs-app-monthly` — Build of `master` branch updated 1st of each month. -- `emacs-app-nightly` — Latest nightly build of Emacs' `master` branch. +- `emacs-app` — Latest official release of Emacs: + ``` + brew install jimeh/emacs-builds/emacs-app + ``` +- `emacs-app-pretest` — Latest pretest build of Emacs based on pretest git tags: + ``` + brew install jimeh/emacs-builds/emacs-app-pretest + ``` +- `emacs-app-monthly` — Build of `master` branch updated 1st of each month: + ``` + brew install jimeh/emacs-builds/emacs-app-monthly + ``` +- `emacs-app-nightly` — Latest nightly build of Emacs' `master` branch: + ``` + brew install jimeh/emacs-builds/emacs-app-nightly + ``` - `emacs-app-good` — Latest "known good" nightly build of Emacs, as tracked by - [jimeh/emacs-builds#7](https://github.com/jimeh/emacs-builds/issues/7). + [jimeh/emacs-builds#7](https://github.com/jimeh/emacs-builds/issues/7): + ``` + brew install jimeh/emacs-builds/emacs-app-good + ``` ### Deprecated @@ -41,7 +52,5 @@ The following Casks are deprecated, and no longer updated: ## Apple Silicon -As of writing (2023-11-21), only the `emacs-app-monthly` casks includes native -Apple Silicon builds. The rest are Intel-only, but can run via Rosetta on Apple -Silicon machines. The stable `emacs-app` cask will soon be updated to also -include native Apple Silicon builds. +As of 2024-11-30, all builds include both Apple Silicon (arm64) and Intel +(x86_64) artifacts.