diff --git a/README.md b/README.md index 78a167576..dd499db2e 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,43 @@ -![Current release](https://img.shields.io/github/tag/hlissner/doom-emacs.svg?label=release&style=for-the-badge&color=blueviolet) -[![Join us on Discord](https://img.shields.io/badge/Discord-blue.svg?logo=discord&label=join&style=for-the-badge)](https://discord.gg/bcZ6P3y) -[![build status (master)](https://img.shields.io/travis/hlissner/doom-emacs/master.svg?label=master&style=flat-square)](https://travis-ci.org/hlissner/doom-emacs) -[![build status (develop)](https://img.shields.io/travis/hlissner/doom-emacs/develop.svg?label=develop&style=flat-square)](https://travis-ci.org/hlissner/doom-emacs) + + Made with Doom Emacs + + + Made for Emacs 25.3+ + + + Build status: master + + + Build status: develop + + + Join our discord server + +

![Doom Emacs Screenshot](https://raw.githubusercontent.com/hlissner/doom-emacs/screenshots/main.png) - + - - - -Quick start ------------ - +**Quick start** ```bash git clone https://github.com/hlissner/doom-emacs ~/.emacs.d ~/.emacs.d/bin/doom quickstart ``` -> Doom supports Emacs 25.3 and newer, but **Emacs 26.1+ is recommended.** Doom -> works best on Linux & MacOS. Your mileage may vary on Windows. - - -Table of Contents -================== +**Table of Contents** - [What is Doom Emacs](#what-is-doom-emacs) - [Doom's mantras](#dooms-mantras) - [Feature highlights](#feature-highlights)