Skip to content

Commit a240106

Browse files
committed
Clarify intro in README and manual
The first sentence a new user should see should ideally answer the questions: * What is rust-analyzer? * Why might I want to use it? The vast majority of users will be interested in using rust-analyzer inside their favourite editor. We should clarify that rust-analyzer is an LSP implementation and that it supports all the classic IDE features. Whilst it's also true that rust-analyzer is modular and organised into libraries, the first impression should (I think) focus on an overview and the primary use case.
1 parent a91fb2b commit a240106

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@
44
alt="rust-analyzer logo">
55
</p>
66

7-
rust-analyzer is a modular compiler frontend for the Rust language.
8-
It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.
7+
rust-analyzer is a language server that provides IDE functionality for
8+
writing Rust programs. You can use it with any editor that supports
9+
the [Language Server
10+
Protocol](https://microsoft.github.io/language-server-protocol/) (VS
11+
Code, Vim, Emacs, Zed, etc).
12+
13+
rust-analyzer features include go-to-definition, find-all-references,
14+
refactorings and code completion. rust-analyzer also supports
15+
integrated formatting (with rustfmt) and integrated diagnostics (with
16+
rustc and clippy).
917

1018
## Quick Start
1119

docs/book/src/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# rust-analyzer
22

3-
At its core, rust-analyzer is a **library** for semantic analysis of
4-
Rust code as it changes over time. This manual focuses on a specific
5-
usage of the library -- running it as part of a server that implements
3+
rust-analyzer is a language server that provides IDE functionality for
4+
writing Rust programs. You can use it with any editor that supports
65
the [Language Server
7-
Protocol](https://microsoft.github.io/language-server-protocol/) (LSP).
8-
The LSP allows various code editors, like VS Code, Emacs or Vim, to
9-
implement semantic features like completion or goto definition by
10-
talking to an external language server process.
6+
Protocol](https://microsoft.github.io/language-server-protocol/) (VS
7+
Code, Vim, Emacs, Zed, etc).
8+
9+
rust-analyzer features include go-to-definition, find-all-references,
10+
refactorings and code completion. rust-analyzer also supports
11+
integrated formatting (with rustfmt) and integrated diagnostics (with
12+
rustc and clippy).
1113

1214
To improve this document, send a pull request:
1315
[https://github.com/rust-lang/rust-analyzer](https://github.com/rust-lang/rust-analyzer/blob/master/docs/book/README.md)

0 commit comments

Comments
 (0)