X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=8c3f6f8468bf6f64a1872b1c637fd774c844cbdc;hb=d8ddde27f9c37ba23b4eaab24759e2c1459e8ad4;hp=3a0c9dee1631b17a7408a7072b227e88fa19a8d0;hpb=90ff3ba64133c1bcae9d49709c4dd704ae59b1ee;p=rust.git diff --git a/README.md b/README.md index 3a0c9dee163..8c3f6f8468b 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,49 @@ -# Rust Analyzer +

+ rust-analyzer logo +

-[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer) +rust-analyzer is a 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. -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 -in the compiler-team repository: +## Quick Start -https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0 +https://rust-analyzer.github.io/manual.html#installation -Work on the Rust Analyzer is sponsored by - -[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/) - -## 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. +## Documentation -To build rust-analyzer, you need: +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. -* latest stable rust for language server itself -* latest stable npm and VS Code for VS Code extension (`code` should be in path) +If you want to **use** rust-analyzer's language server with your editor of +choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. +It also contains some tips & tricks to help you be more productive when using rust-analyzer. -For setup for other editors, see [./docs/user](./docs/user). +## Security and Privacy -``` -# clone the repo -$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer +See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security). -# install both the language server and VS Code extension -$ cargo install-code +## Communication -# alternatively, install only the server. Binary name is `ra_lsp_server`. -$ cargo install-lsp -``` -## Documentation +For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: -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. +https://users.rust-lang.org/c/ide/14 -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 -you be more productive when using rust-analyzer. +For questions about development and implementation, join rust-analyzer working group on Zulip: -## Getting in touch +https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer -We are on the rust-lang Zulip! +## Quick Links -https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 +* Website: https://rust-analyzer.github.io/ +* Metrics: https://rust-analyzer.github.io/metrics/ +* API docs: https://rust-lang.github.io/rust-analyzer/ide/ +* Changelog: https://rust-analyzer.github.io/thisweek ## License -Rust analyzer is primarily distributed under the terms of both the MIT +rust-analyzer is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details.