abo-abo / lispy

Short and sweet LISP editing
http://oremacs.com/lispy/
1.2k stars 132 forks source link

Document lispytutor.el #296

Open Wilfred opened 8 years ago

Wilfred commented 8 years ago

I checked out the lispy code and noticed lispytutor.el. I can't see any mention of it in the README nor http://oremacs.com/lispy/, but it looks really useful.

Is it worth adding to the readme? Furthermore, how do I use it? The comments look like they're using some specific syntax, so I presume I shouldn't just use emacs-lisp-mode.

abo-abo commented 8 years ago

It's simply emacs-lisp-mode. The extra stuff is for the bindings, you can enable it like this:

(font-lock-add-keywords
 'emacs-lisp-mode
 '(("=\\([^=\n]+\\)=" 1 font-lock-string-face prepend)))

Is it worth adding to the readme?

Might be. I thought it's in a semi-finished state, since it doesn't cover everything. But it's not bad at things it does cover.

Furthermore, how do I use it?

Just like vimtutor: simply open it and read the instructions, repeat the keys. If something's not clear, open an issue or a PR.