]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Move project discovery
[rust.git] / README.md
index dbc110a905cf3a5c6924805cb7918850acdaf303..1e7c3e9b4344b7bce027dc481e04784aef244d1d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,62 +1,46 @@
-# Rust Analyzer
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo">
+</p>
 
-[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
-
-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
-in the compiler-team repository:
+support for Rust. If you want to get involved, check the rls-2.0 working group:
 
-https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
+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/)
 - [Mozilla](https://www.mozilla.org/en-US/)
+- [freiheit.com](https://www.freiheit.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.
-
-To build rust-analyzer, you need:
-
-* latest stable rust for language server itself
-* latest stable npm and VS Code for VS Code extension (`code` should be in path)
+## Quick Start
 
-For setup for other editors, see [./docs/user](./docs/user).
+https://rust-analyzer.github.io/manual.html#installation
 
-```
-# clone the repo
-$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
-
-# install both the language server and VS Code extension
-$ cargo install-code
-
-# alternatively, install only the server. Binary name is `ra_lsp_server`.
-$ cargo install-lsp
-```
 ## 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
+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.
 
-## Getting in touch
+## Communication
+
+For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
+
+https://users.rust-lang.org/c/ide/14
 
-We are on the rust-lang Zulip!
+For questions about development and implementation, join rls-2.0 working group on Zulip:
 
 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
 
 ## Quick Links
 
-* Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
-* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html
-* CI: https://travis-ci.org/rust-analyzer/rust-analyzer
+* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
+* Website: https://rust-analyzer.github.io/
 
 ## License