Update "How do I run it" in README

emacs-elsa / Elsa

Emacs Lisp Static Analyzer and gradual type system.

GNU General Public License v3.0

644 stars 27 forks source link

Update "How do I run it" in README #135

Closed Fuco1 closed 5 years ago

Fuco1 commented 5 years ago

Elsa is now on MELPA so that should be the default channel.

update the Cask instructions (should still be default)
expand the flycheck section (how to install, what to setup in Emacs)
mention emake.el (@vermiculus can you write a short paragraph on how to run it?)
mention how to run it "DIY style" (not recommended)

vermiculus commented 5 years ago

Here's what I would say for EMake:

Install EMake via the usual means (bash <(curl -fsSL https://raw.githubusercontent.com/vermiculus/emake.el/master/new)). You can now run Elsa's checks with make lint-elsa.

I say 'usual' like it's been around for a while – but I only wrote it this evening being prompted by this issue 😄 I realized there were too many steps for install (previously: well, everything in that script).

Fuco1 commented 5 years ago

@vermiculus thanks, that is simpler than I expected :D

vermiculus commented 5 years ago

😉 Note actual Elsa support is dependent on vermiculus/emake.el#27.