From 26b12fac2779fd7e7c4e3b38832a72a8725da4fb Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Tue, 29 Jun 2021 02:40:18 +0100 Subject: [PATCH] docs(readme): update readme about homebrew cask installation method --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50ca44f..bcbaf56 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,9 @@ - Intel-based Mac running macOS 10.15.x or later. -## Downloads +## Installation + +### Manual Download See the [Releases][] page to download latest builds. @@ -73,8 +75,43 @@ any issues. [releases]: https://github.com/jimeh/emacs-builds/releases [7]: https://github.com/jimeh/emacs-builds/issues/7 +### Homebrew Cask + +Install the `jimeh/emacs-builds` Homebrew tap: + +``` +brew tap jimeh/emacs-builds +``` + +Then either install the latest nightly build: + +``` +brew install --cask emacs-app-nightly +``` + +Or install the latest known good build listed on [#7][7]: + +``` +brew install --cask emacs-app-good +``` + +[7]: https://github.com/jimeh/emacs-builds/issues/7 + ## Use Emacs.app as `emacs` CLI Tool +### Installed via Homebrew Cask + +The cask installation method sets up CLI usage automatically by exposing a +`emacs` command. However it will launch Emacs into GUI mode. To instead have +`emacs` in your terminal open a terminal instance of Emacs, add the following +alias to your shell setup: + +```bash +alias emacs="emacs -nw" +``` + +### Installed Manually + Builds come with a custom `emacs` shell script launcher for use from the command line, located next to `emacsclient` in `Emacs.app/Contents/MacOS/bin`.