[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eglot 606e234 48/54: Close #415: mention soft dependenc
From: |
João Távora |
Subject: |
[elpa] externals/eglot 606e234 48/54: Close #415: mention soft dependencies in README |
Date: |
Thu, 16 Apr 2020 05:31:53 -0400 (EDT) |
branch: externals/eglot
commit 606e234ea867d057f201fde9a4de2a896f35782e
Author: João Távora <address@hidden>
Commit: Felicián Németh <address@hidden>
Close #415: mention soft dependencies in README
* README.md (How does Eglot work?): Mention soft dependencies.
---
README.md | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 7152de6..42e1ffc 100644
--- a/README.md
+++ b/README.md
@@ -304,11 +304,25 @@ If the connection is successful, you see an
`[eglot:<server>]`
indicator pop up in your mode-line. More importantly, this means
current *and future* file buffers of that major mode *inside your
current project* automatically become \"managed\" by the LSP server,
-i.e. information about their contents is exchanged periodically to
-provide enhanced code analysis via `xref-find-definitions`,
-`flymake-mode`, `eldoc-mode`, `completion-at-point`, among others.
+This means that information about these file's contents is exchanged
+periodically to provide enhanced code analysis. Among other features:
-To "unmanage" these buffers, shutdown the server with `M-x
+* definitions can be found via `xref-find-definitions`;
+* on-the-fly diagnostics are given by `flymake-mode`;
+* function signature hints are given by `eldoc-mode`;
+* completion can be summoned with `completion-at-point`.
+
+Some extra features are provided if certain libraries are installed
+and enabled, such as:
+
+* completion dropdowns via [company];
+* snippet completions via [yasnippet];
+* marked-up documentation via [markdown].
+
+Eglot doesn't _require_ these libraries to work effectively, but will
+use them automatically if they are found to be active.
+
+To "unmanage" a project's buffers, shutdown the server with `M-x
eglot-shutdown`.
# Supported Protocol features
@@ -520,3 +534,4 @@ Under the hood:
[company]: http://elpa.gnu.org/packages/company.html
[flymake]:
https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html#Top
[yasnippet]: http://elpa.gnu.org/packages/yasnippet.html
+[markdown]: https://github.com/defunkt/markdown-mode
- [elpa] externals/eglot 8332cdf 52/54: Fix eglot-move-to-lsp-abiding-column (#361), (continued)
- [elpa] externals/eglot 8332cdf 52/54: Fix eglot-move-to-lsp-abiding-column (#361), João Távora, 2020/04/16
- [elpa] externals/eglot 864a493 50/54: Close #323: add a simple github issue template, João Távora, 2020/04/16
- [elpa] externals/eglot 4496657 34/54: Close #393: use completing-read in eglot-code-actions, João Távora, 2020/04/16
- [elpa] externals/eglot 9c52f24 36/54: Fix #277: Send exit as a notification, João Távora, 2020/04/16
- [elpa] externals/eglot 9f10a27 42/54: Explain the animations in the README, João Távora, 2020/04/16
- [elpa] externals/eglot e02479a 54/54: * eglot.el (Version): Bump to 1.6, João Távora, 2020/04/16
- [elpa] externals/eglot 212a7f7 43/54: Per #315: call shutdown/exit methods with params:{}, not null, João Távora, 2020/04/16
- [elpa] externals/eglot 8d8c90d 45/54: Fix #182: add public hook eglot-managed-mode-hook, João Távora, 2020/04/16
- [elpa] externals/eglot 16dd4b8 47/54: Close #414: mention eglot-find-* in README, João Távora, 2020/04/16
- [elpa] externals/eglot 2209779 49/54: Fix #425: Ignore empty hover info, João Távora, 2020/04/16
- [elpa] externals/eglot 606e234 48/54: Close #415: mention soft dependencies in README,
João Távora <=
- [elpa] externals/eglot cacfd24 53/54: Fix #361: abide by LSP when reporting and moving to columns, João Távora, 2020/04/16