search

syl20bnr / evil-tutor

Vimtutor adapted to Emacs+Evil and wrapped in a major mode.
GNU General Public License v3.0
87 stars 12 forks source link

Add proper installation instruction for Doom Emacs in README.md #12

Open Jintekki opened 2 years ago

Jintekki commented 2 years ago

The README advises installing via M-x evil-tutor-start, but Doom Emacs (a very popular configuration framework for Evil Mode) does not use the same package manager as vanilla Emacs.

WARNING: Do not install packages directly (with M-x package-install or M-x straight-use-package). Without an accompanying package! declaration somewhere these packages will be forgotten when you restart Emacs and uninstalled the next time you run doom sync or doom purge.

Instead, the following line should be added in your ~/.doom.d/packages.el file: (package! evil-tutor), then a doom sync should be ran.

eallenOP commented 1 year ago

Thanks, this is the only help in this whole repo for how to actually install this tutor for Doom users.