[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/elpa 9d404c9 054/139: Update README.md
From: |
João Távora |
Subject: |
[elpa] externals/elpa 9d404c9 054/139: Update README.md |
Date: |
Mon, 14 May 2018 09:53:33 -0400 (EDT) |
branch: externals/elpa
commit 9d404c98d7de60f02278cfd1ef84416792690169
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>
Update README.md
---
README.md | 40 ++++++++++++++++++++++++++++++++++++++--
1 file changed, 38 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 7a747fd..8809421 100644
--- a/README.md
+++ b/README.md
@@ -3,11 +3,47 @@ Eglot
*E*macs Poly*glot*. An Emacs client to Language Server Protocol servers.
-Coming soon.
-
```
(add-to-list 'load-path "/path/to/eglot")
(require 'eglot)
M-x eglot
```
+
+*That's it*. Either this guesses the local LSP program to start for
+the language of your choice or it prompts you for such a thing. You
+can also enter a `server:port` pattern to connect to an LSP server. To
+skip the guess and always be prompted use `C-u M-x eglot`.
+
+## Differences to lsp-mode.el
+
+This is really beta and currently does less than
+[lsp-mode.el](https://github.com/emacs-lsp/lsp-mode) which is more
+mature. Though I think `eglot.el` will eventually beat it, you could
+be better served with `lsp-mode.el` for now.
+
+User-visible differences:
+
+- Single entry point, `M-x eglot` to enable LSP in a project.
+ Automatically detects current and future opened files under that
+ project and syncs with server.
+- Easy way to restart a server
+- Pretty interactive mode-line section for live tracking of server
+ communication.
+
+Differences under the hood:
+
+- Message parser is much much simpler
+- Easier to read and maintain elisp. Yeah I know, subjective... But
+ judge for yourself.
+- No external dependencies apart from Emacs (no `flycheck.el`, no
+ `projectile.el`, no Cask, etc).
+- Uses project.el, flymake.el
+- Requires the upcoming emacs 26
+- Contained in one file
+- send `textDocument/didChange` for groups of edits, not one per each
+ tiny change.
+- Its missing tests! This is *not good*
+
+
+
- [elpa] externals/elpa 79a2a1e 069/139: Be quite explicit about our lack of capabilities right now, (continued)
- [elpa] externals/elpa 79a2a1e 069/139: Be quite explicit about our lack of capabilities right now, João Távora, 2018/05/14
- [elpa] externals/elpa ff5a03d 074/139: Very basic xref support, João Távora, 2018/05/14
- [elpa] externals/elpa b1554fc 055/139: * eglot.el (eglot--process-receive): Skip null method notifs., João Távora, 2018/05/14
- [elpa] externals/elpa 9882bf2 072/139: Cleanup mistake with TextDocumentItem and TextDocumentIdentifier, João Távora, 2018/05/14
- [elpa] externals/elpa fc6879f 084/139: Explain why didOpen on after-revert-hook is a bad idea, João Távora, 2018/05/14
- [elpa] externals/elpa fdb4de1 039/139: Simplify flymake integration, João Távora, 2018/05/14
- [elpa] externals/elpa 39e8b9e 081/139: Add (dummy) tests and Travis CI integration, João Távora, 2018/05/14
- [elpa] externals/elpa 1356844 097/139: Fix odd bugs, João Távora, 2018/05/14
- [elpa] externals/elpa 889ef20 085/139: Tweak the async request engine., João Távora, 2018/05/14
- [elpa] externals/elpa 1add335 078/139: Workaround two suspected Emacs bugs, João Távora, 2018/05/14
- [elpa] externals/elpa 9d404c9 054/139: Update README.md,
João Távora <=
- [elpa] externals/elpa c417eb4 009/139: Cancel timeouts when process dies unexpectedly, João Távora, 2018/05/14
- [elpa] externals/elpa 6689a15 026/139: Add eglot-clear-status interactive command, João Távora, 2018/05/14
- [elpa] externals/elpa 63f2208 030/139: Less obstrusive flymake stuff for now, João Távora, 2018/05/14
- [elpa] externals/elpa 3403f86 027/139: Correctly report what we currently are capable of, João Távora, 2018/05/14
- [elpa] externals/elpa 92bf3a0 038/139: Signal textDocument/didClose, João Távora, 2018/05/14
- [elpa] externals/elpa 7ec0dcf 029/139: Events buffer uses eglot-mode, source buffers use eglot-editing-mode, João Távora, 2018/05/14
- [elpa] externals/elpa 17e0ca4 047/139: Fix Flymake diagnostic positions, João Távora, 2018/05/14
- [elpa] externals/elpa 0e95167 042/139: Watch for files opened under umbrella of existing process, João Távora, 2018/05/14
- [elpa] externals/elpa 9665a3e 051/139: Fix textDocument/didChange, João Távora, 2018/05/14
- [elpa] externals/elpa 1514e0f 052/139: Fix a couple of Rust-related edge cases, João Távora, 2018/05/14