aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index cbb72c8cf..304c2620a 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,6 @@ Work on the Rust Analyzer is sponsored by
14 14
15[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/) 15[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
16 16
17
18## Quick Start 17## Quick Start
19 18
20Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition. 19Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
@@ -36,6 +35,11 @@ $ cargo install --path crates/ra_lsp_server
36See [these instructions](./editors/README.md) for VS Code setup and the list of 35See [these instructions](./editors/README.md) for VS Code setup and the list of
37features (some of which are VS Code specific). 36features (some of which are VS Code specific).
38 37
38## Debugging
39
40See [these instructions](./DEBUGGING.md) for VS Code setup and the list of
41features (some of which are VS Code specific).
42
39## Current Status and Plans 43## Current Status and Plans
40 44
41Rust analyzer aims to fill the same niche as the official [Rust Language 45Rust analyzer aims to fill the same niche as the official [Rust Language
@@ -53,11 +57,11 @@ The near/mid term plan is to work independently of the main rustc compiler and
53implement at least simplistic versions of name resolution, macro expansion and 57implement at least simplistic versions of name resolution, macro expansion and
54type inference. The purpose is two fold: 58type inference. The purpose is two fold:
55 59
56* to quickly bootstrap usable and useful language server: solution that covers 60- to quickly bootstrap usable and useful language server: solution that covers
57 80% of Rust code will be useful for IDEs, and will be vastly simpler than 100% 61 80% of Rust code will be useful for IDEs, and will be vastly simpler than 100%
58 solution. 62 solution.
59 63
60* to understand how the consumer-side of compiler API should look like 64- to understand how the consumer-side of compiler API should look like
61 (especially it's on-demand aspects). If you have `get_expression_type` 65 (especially it's on-demand aspects). If you have `get_expression_type`
62 function, you can write a ton of purely-IDE features on top of it, even if the 66 function, you can write a ton of purely-IDE features on top of it, even if the
63 function is only partially correct. Pluging in the precise function afterwards 67 function is only partially correct. Pluging in the precise function afterwards
@@ -77,7 +81,6 @@ implemented in Rust: [https://discord.gg/sx3RQZB](https://discord.gg/sx3RQZB).
77 81
78See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md) 82See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
79 83
80
81## License 84## License
82 85
83Rust analyzer is primarily distributed under the terms of both the MIT 86Rust analyzer is primarily distributed under the terms of both the MIT