From 9bb699b28db69c4c77034055a922a52b0a5c2b20 Mon Sep 17 00:00:00 2001 From: Florian Diebold Date: Sun, 9 Feb 2020 13:34:56 +0100 Subject: [PATCH] Some README fixes/cleanups Make capitalization more consistent and fix some typos. --- README.md | 20 ++++++++++---------- crates/ra_syntax/Cargo.toml | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2f6ed1e05d..fabb8479d4 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ rust-analyzer logo

-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 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 -Work on the Rust Analyzer is sponsored by +Work on rust-analyzer is sponsored by [Ferrous Systems](https://ferrous-systems.com/) - [Mozilla](https://www.mozilla.org/en-US/) @@ -16,17 +16,17 @@ Work on the Rust Analyzer is sponsored by ## Language Server Quick Start -Rust Analyzer is a work-in-progress, so you'll have to build it from source, and -you might encounter critical bugs. That said, it is complete enough to provide a -useful IDE experience and some people use it as a daily driver. +rust-analyzer is a work-in-progress, so you might encounter critical bugs. That +said, it is complete enough to provide a useful IDE experience and some people +use it as a daily driver. 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 -To quickly install rust-analyzer with VS Code extension with standard setup -(`code` and `cargo` in `$PATH`, etc), use this: +To quickly install the rust-analyzer language server and VS Code extension with +standard setup (`code` and `cargo` in `$PATH`, etc), use this: ``` # clone the repo @@ -44,8 +44,8 @@ cannot start, see [./docs/user](./docs/user). ## Documentation -If you want to **contribute** to rust-analyzer or just curious about how things work -under the hood, check the [./docs/dev](./docs/dev) folder. +If you want to **contribute** to rust-analyzer or are just curious about how +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 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help diff --git a/crates/ra_syntax/Cargo.toml b/crates/ra_syntax/Cargo.toml index c5a3d19998..83db943fec 100644 --- a/crates/ra_syntax/Cargo.toml +++ b/crates/ra_syntax/Cargo.toml @@ -4,7 +4,7 @@ name = "ra_syntax" version = "0.1.0" authors = ["rust-analyzer developers"] 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" [lib]