From bcdadcd45d9cbe83dbdcb225c50fa9ba2cb9b994 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Fri, 27 Mar 2020 17:51:37 -0400 Subject: [PATCH] Mention dependencies in README And recommend Emacs 26 or 27, but not 28. --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a86397f6b..12d2ff791 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,18 @@ **Quick start** -```bash -git clone https://github.com/hlissner/doom-emacs ~/.emacs.d -~/.emacs.d/bin/doom install -``` +1. **Install Emacs 26.1+**. 27 is recommended. _28+ is not supported_. +2. Install [ripgrep](https://github.com/BurntSushi/ripgrep) 11.0+. +3. Windows and BSD users will need GNU Find. +4. Clone Doom and run its installer: -More details, including dependencies and how to install Emacs, can be found [in -the documentation](docs/getting_started.org#install). + ```bash + git clone https://github.com/hlissner/doom-emacs ~/.emacs.d + ~/.emacs.d/bin/doom install + ``` + +Find more detailed install instructions [in the +documentation](docs/getting_started.org#install). **Table of Contents**