<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/rust-analyzer/README.md - fork/rust @ master</title>
<meta name="description" content="src/tools/rust-analyzer/README.md in fork/rust at master.">
<meta property="og:title" content="src/tools/rust-analyzer/README.md - fork/rust @ master">
<meta property="og:description" content="src/tools/rust-analyzer/README.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/rust-analyzer/">rust-analyzer</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>49 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/8c3f6f8468bf6f64a1872b1c637fd774c844cbdc/src/tools/rust-analyzer/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;p align="center"&gt;
  &lt;img
    src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
    alt="rust-analyzer logo"&gt;
&lt;/p&gt;
<p>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.</p>
<h2>Quick Start</h2>
<p>https://rust-analyzer.github.io/manual.html#installation</p>
<h2>Documentation</h2>
<p>If you want to <strong>contribute</strong> to rust-analyzer or are just curious about how
things work under the hood, check the <a href="/fork/rust/ref/master/tree/src/tools/rust-analyzer/docs/dev/">./docs/dev</a> folder.</p>
<p>If you want to <strong>use</strong> rust-analyzer's language server with your editor of
choice, check <a href="https://rust-analyzer.github.io/manual.html">the manual</a> folder.
It also contains some tips &amp; tricks to help you be more productive when using rust-analyzer.</p>
<h2>Security and Privacy</h2>
<p>See the corresponding sections of <a href="https://rust-analyzer.github.io/manual.html#security">the manual</a>.</p>
<h2>Communication</h2>
<p>For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:</p>
<p>https://users.rust-lang.org/c/ide/14</p>
<p>For questions about development and implementation, join rust-analyzer working group on Zulip:</p>
<p>https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer</p>
<h2>Quick Links</h2>
<ul>
<li>Website: https://rust-analyzer.github.io/</li>
<li>Metrics: https://rust-analyzer.github.io/metrics/</li>
<li>API docs: https://rust-lang.github.io/rust-analyzer/ide/</li>
<li>Changelog: https://rust-analyzer.github.io/thisweek</li>
</ul>
<h2>License</h2>
<p>rust-analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).</p>
<p>See LICENSE-APACHE and LICENSE-MIT for details.</p>
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/rust-analyzer/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">&lt;p align=&quot;center&quot;&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">  &lt;img</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">    src=&quot;https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">    alt=&quot;rust-analyzer logo&quot;&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">&lt;/p&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">rust-analyzer is a modular compiler frontend for the Rust language.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">## Quick Start</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">https://rust-analyzer.github.io/manual.html#installation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">## Documentation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">If you want to **contribute** to rust-analyzer or are just curious about how</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">things work under the hood, check the [./docs/dev](./docs/dev) folder.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">If you want to **use** rust-analyzer's language server with your editor of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">It also contains some tips &amp; tricks to help you be more productive when using rust-analyzer.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">## Security and Privacy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">## Communication</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">For usage and troubleshooting requests, please use &quot;IDEs and Editors&quot; category of the Rust forum:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">https://users.rust-lang.org/c/ide/14</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">For questions about development and implementation, join rust-analyzer working group on Zulip:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">## Quick Links</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">* Website: https://rust-analyzer.github.io/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">* Metrics: https://rust-analyzer.github.io/metrics/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">* API docs: https://rust-lang.github.io/rust-analyzer/ide/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">* Changelog: https://rust-analyzer.github.io/thisweek</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">rust-analyzer is primarily distributed under the terms of both the MIT</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">license and the Apache License (Version 2.0).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">See LICENSE-APACHE and LICENSE-MIT for details.</span></span></pre></div></div>
</main>
</body>
</html>
