Critical bugfixes! Momentus edits of paramount importance crucial to the long-term success of the project

A few tweaks to the readme:
 1. Replaced typographic approximation of em dashes with … em dashes
 2. Made parenthesis surrounding italic text non-italic (yes, it's an improvement — Robert Bringhurst agrees with me [5.3.2 of his book])
 3. Made `project/?` links actually link to the project pages (relative links like `/?` resolve to `/blob/?`)
 4. Replaced code blocks around keypresses with `<kbd></kbd>` as is used earlier in the readme
 5. Fixed new issue link, as in (3)
This commit is contained in:
tecosaur 2020-04-26 15:35:04 +08:00 committed by GitHub
parent e1a9bf234f
commit 5edfcec2df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -32,7 +32,7 @@
</a> </a>
> It is a story as old as time. A stubborn, shell-dwelling, and melodramatic > It is a story as old as time. A stubborn, shell-dwelling, and melodramatic
> vimmer -- envious of the features of modern text editors -- spirals into > vimmer—envious of the features of modern text editors—spirals into
> despair before he succumbs to the [dark side][evil-mode]. This is his config. > despair before he succumbs to the [dark side][evil-mode]. This is his config.
Doom is a configuration framework for [GNU Emacs] tailored for Emacs bankruptcy Doom is a configuration framework for [GNU Emacs] tailored for Emacs bankruptcy
@ -98,7 +98,7 @@ Check out [the FAQ][FAQ] for answers to common questions about the project.
# Prerequisites # Prerequisites
+ Git 2.23+ + Git 2.23+
+ Emacs 26.1+ *(27 is recommended)* with GNUTLS support + Emacs 26.1+ (*27 is recommended*) with GNUTLS support
+ [ripgrep] 11.0+ + [ripgrep] 11.0+
+ GNU `find` + GNU `find`
+ *OPTIONAL:* [fd] 7.3.0+ (improves file indexing performance for some commands) + *OPTIONAL:* [fd] 7.3.0+ (improves file indexing performance for some commands)
@ -138,12 +138,12 @@ Doom is an active and ongoing project. To make that development more
transparent, its roadmap (and other concerns) are published across three github transparent, its roadmap (and other concerns) are published across three github
project boards and a newsletter: project boards and a newsletter:
+ [Development Roadmap](/projects/3): roughly outlines our goals between release + [Development Roadmap](https://github.com/hlissner/doom-emacs/projects/3): roughly outlines our goals between release
milestones and their progress. milestones and their progress.
+ [Plugins under review](/projects/2): lists plugins we are watching and + [Plugins under review](https://github.com/hlissner/doom-emacs/projects/2): lists plugins we are watching and
considering for inclusion, and what their status for inclusion is. Please considering for inclusion, and what their status for inclusion is. Please
consult this list before requesting new packages/features. consult this list before requesting new packages/features.
+ [Upstream bugs](/projects/5): lists issues that originate from elsewhere, and + [Upstream bugs](https://github.com/hlissner/doom-emacs/projects/5): lists issues that originate from elsewhere, and
whether or not we have local workarounds or temporary fixes for them. whether or not we have local workarounds or temporary fixes for them.
+ ~~Doom's newsletter~~ (not finished) will contain changelogs in between + ~~Doom's newsletter~~ (not finished) will contain changelogs in between
releases. releases.
@ -167,10 +167,10 @@ mysterious errors. When you do, here are some places you can look for help:
+ [This answer][change-font] shows you how to change the default font. + [This answer][change-font] shows you how to change the default font.
+ Your issue may be documented in the [FAQ]. + Your issue may be documented in the [FAQ].
+ With Emacs built-in help system documentation is a keystroke away: + With Emacs built-in help system documentation is a keystroke away:
+ For functions: `SPC h f` or `C-h f` + For functions: <kbd>SPC h for</kbd> or <kbd>C-h f</kbd>
+ For variables: `SPC h v` or `C-h v` + For variables: <kbd>SPC h v</kbd> or <kbd>C-h v</kbd>
+ For a keybind: `SPC h k` or `C-h k` + For a keybind: <kbd>SPC h k</kbd> or <kbd>C-h k</kbd>
+ To search available keybinds: `SPC h b b` or `C-h b b` + To search available keybinds: <kbd>SPC h b b</kbd> or <kbd>C-h b b</kbd>
+ Run `bin/doom doctor` to detect common issues with your development + Run `bin/doom doctor` to detect common issues with your development
environment and private config. environment and private config.
+ Check out the [FAQ], in case your question has already been answered. + Check out the [FAQ], in case your question has already been answered.
@ -192,7 +192,7 @@ kind!
+ I :heart: pull requests and bug reports (see the [Contributing + I :heart: pull requests and bug reports (see the [Contributing
Guidelines][contribute])! Guidelines][contribute])!
+ Don't hesitate to [tell me my Elisp-fu sucks](/issues/new), but please tell me + Don't hesitate to [tell me my Elisp-fu sucks](https://github.com/hlissner/doom-emacs/issues/new), but please tell me
why. why.
+ Hop on [our Discord server][Discord] and say hi! Help others, hang out or talk + Hop on [our Discord server][Discord] and say hi! Help others, hang out or talk
to me about Emacs, gamedev, programming, physics, pixel art, anime, gaming -- to me about Emacs, gamedev, programming, physics, pixel art, anime, gaming --