Skip to content

Commit a36bc70

Browse files
authored
Merge pull request #340 from brotzeit/readme
mention LSP support
2 parents c8217a3 + 9107989 commit a36bc70

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,23 @@
55
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
66
**Table of Contents**
77

8-
- [Installation via MELPA](#installation-via-melpa)
9-
- [Manual Installation](#manual-installation)
8+
- [Installation](#installation)
9+
- [Melpa](#melpa)
10+
- [straight](#straight)
11+
- [Manual Installation](#manual-installation)
1012
- [Indentation](#indentation)
1113
- [rustfmt](#rustfmt)
1214
- [Tests](#tests)
15+
- [LSP](#lsp)
16+
- [eglot](#eglot)
17+
- [lsp-mode](#lsp-mode)
1318
- [Other useful packages](#other-useful-packages)
1419

1520
<!-- markdown-toc end -->
1621

17-
# Installation via MELPA
22+
# Installation
23+
24+
## Melpa
1825

1926
`rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs
2027
enjoyable. It requires Emacs 24 or later.
@@ -36,7 +43,11 @@ And put this in your config to load rust-mode automatically:
3643

3744
`(require 'rust-mode)`
3845

39-
# Manual Installation
46+
## straight
47+
48+
[straight.el](https://github.com/raxod502/straight.el#install-packages) clones each of your packages directly from its source. There are good additional [installation instructions](https://github.crookster.org/switching-to-straight.el-from-emacs-26-builtin-package.el/) for moving your package management from package.el to straight.
49+
50+
## Manual Installation
4051

4152
Add this to your init.el:
4253

@@ -71,6 +82,19 @@ The file `rust-mode-tests.el` contains tests that can be run via
7182
You can use `run_rust_emacs_tests.sh` to run them in batch mode, if
7283
you set the environment variable EMACS to a program that runs emacs.
7384

85+
# LSP
86+
87+
## eglot
88+
89+
[Installation instructions](https://github.com/joaotavora/eglot#connecting-automatically)
90+
91+
## lsp-mode
92+
93+
[Installation instructions](https://github.com/emacs-lsp/lsp-mode#installation)
94+
95+
96+
You can find more information in the [lsp-mode wiki](https://github.com/emacs-lsp/lsp-mode/wiki/Rust).
97+
7498
# Other useful packages
7599

76100
* [cargo.el](https://github.com/kwrooijen/cargo.el) Emacs Minor Mode for Cargo, Rust's Package Manager

0 commit comments

Comments
 (0)