docs(readme): update readme

Clarify cask list with installation instructions, and also update Apple Silicon information.

Resolves #7
This commit is contained in:
2025-09-09 02:18:24 +01:00
parent 1cad237d0f
commit 0e202ff10b

View File

@@ -1,19 +1,15 @@
<h1 align="center">
Homebrew Tap: emacs-builds
</h1>
<div align="center">
<p align="center">
<a href="https://github.com/jimeh/homebrew-emacs-builds/actions"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/jimeh/homebrew-emacs-builds/update-casks.yml?style=flat&label=build&logo=github&logoColor=white"></a>
<a href="https://github.com/jimeh/homebrew-emacs-builds/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/jimeh/homebrew-emacs-builds?style=flat&logo=github"></a>
<a href="https://github.com/jimeh/homebrew-emacs-builds/pulls"><img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr-raw/jimeh/homebrew-emacs-builds?style=flat&logo=github"></a>
</p>
# Homebrew Tap: emacs-builds
<p align="center">
<strong>
Homebrew tap for binary builds of Emacs provided by
<a href="https://github.com/jimeh/emacs-builds">jimeh/emacs-builds</a>.
</strong>
</p>
[![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).*
</div>
## 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.