Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 05:38:46 +00:00
Code Issues Projects Releases Packages Wiki Activity

Some README fixes/cleanups

Browse source 
Make capitalization more consistent and fix some typos.
This commit is contained in:
Florian Diebold 2020-02-09 13:34:56 +01:00
parent 01836a0f35
commit 9bb699b28d
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -2,13 +2,13 @@
<img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo"> <img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo">
</p> </p>
Rust Analyzer is an **experimental** modular compiler frontend for the Rust rust-analyzer is an **experimental** modular compiler frontend for the Rust
language. It is a part of a larger rls-2.0 effort to create excellent IDE language. It is a part of a larger rls-2.0 effort to create excellent IDE
support for Rust. If you want to get involved, check the rls-2.0 working group: support for Rust. If you want to get involved, check the rls-2.0 working group:
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
Work on the Rust Analyzer is sponsored by Work on rust-analyzer is sponsored by
[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/) [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
- [Mozilla](https://www.mozilla.org/en-US/) - [Mozilla](https://www.mozilla.org/en-US/)
@ -16,17 +16,17 @@ Work on the Rust Analyzer is sponsored by
## Language Server Quick Start ## Language Server Quick Start
Rust Analyzer is a work-in-progress, so you'll have to build it from source, and rust-analyzer is a work-in-progress, so you might encounter critical bugs. That
you might encounter critical bugs. That said, it is complete enough to provide a said, it is complete enough to provide a useful IDE experience and some people
useful IDE experience and some people use it as a daily driver. use it as a daily driver.
To build rust-analyzer, you need: To build rust-analyzer, you need:
* latest stable rust for language server itself * latest stable Rust for the language server itself
* latest stable npm and VS Code for VS Code extension * latest stable npm and VS Code for VS Code extension
To quickly install rust-analyzer with VS Code extension with standard setup To quickly install the rust-analyzer language server and VS Code extension with
(`code` and `cargo` in `$PATH`, etc), use this: standard setup (`code` and `cargo` in `$PATH`, etc), use this:
``` ```
# clone the repo # clone the repo
@ -44,8 +44,8 @@ cannot start, see [./docs/user](./docs/user).
## Documentation ## Documentation
If you want to **contribute** to rust-analyzer or just curious about how things work If you want to **contribute** to rust-analyzer or are just curious about how
under the hood, check the [./docs/dev](./docs/dev) folder. things work under the hood, check the [./docs/dev](./docs/dev) folder.
If you want to **use** rust-analyzer's language server with your editor of If you want to **use** rust-analyzer's language server with your editor of
choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help

2
crates/ra_syntax/Cargo.toml
View file

@ -4,7 +4,7 @@ name = "ra_syntax"
version = "0.1.0" version = "0.1.0"
authors = ["rust-analyzer developers"] authors = ["rust-analyzer developers"]
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
description = "Comment and whitespace preserving parser for the Rust langauge" description = "Comment and whitespace preserving parser for the Rust language"
repository = "https://github.com/rust-analyzer/rust-analyzer" repository = "https://github.com/rust-analyzer/rust-analyzer"
[lib] [lib]