Make cancelFlycheck request a notification

[rust.git] / README.md

diff --git a/README.md b/README.md
index acce7219e15ec0a9d0811cba0de0321d272ffaf1..8c3f6f8468bf6f64a1872b1c637fd774c844cbdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,59 +1,49 @@
-# Rust Analyzer
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
+    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
-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:
-
-https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
-
-Work on the Rust Analyzer is sponsored by
-
-[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
+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.
 
 ## Quick Start
 
-Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
-
-```
-# run tests
-$ cargo test
+https://rust-analyzer.github.io/manual.html#installation
 
-# show syntax tree of a Rust file
-$ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
+## Documentation
 
-# show symbols of a Rust file
-$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
+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.
 
-# install the language server
-$ cargo install-lsp
-or
-$ cargo install --path crates/ra_lsp_server
-```
+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.
 
-See [these instructions](./editors/README.md) for VS Code setup and the list of
-features (some of which are VS Code specific).
+## Security and Privacy
 
-## Debugging
+See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security).
 
-See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server.
+## Communication
 
-## Getting in touch
+For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
 
-We are on the rust-lang Zulip!
+https://users.rust-lang.org/c/ide/14
 
-https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
+For questions about development and implementation, join rust-analyzer working group on Zulip:
 
-## Contributing
+https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
 
-See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
+## Quick Links
 
+* 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.