1
1
flycheck-rust — Flycheck for Rust
2
2
=================================
3
3
4
- [ ![ Build Status] ( https:// travis-ci.org/flycheck/flycheck-rust.svg?branch=master )] ( https:// travis-ci.org/flycheck/flycheck-rust )
4
+ [ ![ Build Status] [ travis-badge ]] [ travis-url ]
5
5
[ ![ License GPL 3] [ badge-license ]] [ copying ]
6
+ [ ![ MELPA] [ MELPA-badge ]] [ MELPA-link ]
6
7
7
- Configure [ Flycheck] [ ] for Rust.
8
+ This Flycheck extension configures Flycheck automatically for the current
9
+ Cargo project.
8
10
9
- - Setup Flycheck to follow the Cargo project layout.
10
-
11
- Installation
12
- ------------
11
+ Setup
12
+ -----
13
13
14
- As usual, from [ MELPA] [ ] or [ MELPA Stable] [ ] .
14
+ Install from [ MELPA] [ ] or [ MELPA Stable] [ ] .
15
15
16
- In your [ ` Cask ` ] [ cask ] file :
16
+ If you use [ ` Cask ` ] [ cask ] :
17
17
18
18
``` emacs-lisp
19
19
(source gnu)
@@ -22,7 +22,7 @@ In your [`Cask`][cask] file:
22
22
(depends-on "flycheck-rust")
23
23
```
24
24
25
- In your ` init.el ` :
25
+ Then, in your ` init.el ` :
26
26
27
27
``` emacs-lisp
28
28
(with-eval-after-load 'rust-mode
@@ -32,7 +32,12 @@ In your `init.el`:
32
32
Usage
33
33
-----
34
34
35
- Just use Flycheck as usual in your Rust/Cargo projects.
35
+ Just use Flycheck as usual in your Rust/Cargo projects. ` flycheck-rust-setup `
36
+ will call ` cargo ` to determine your project layout and set the variables needed
37
+ by the ` rust-cargo ` checker to properly check your buffer.
38
+
39
+ You may also want to have a look at [ flycheck/flycheck-inline] [ flycheck-inline ] ,
40
+ which works well with diagnostics emitted by Rust.
36
41
37
42
License
38
43
-------
@@ -57,3 +62,8 @@ See [`COPYING`][copying] for details.
57
62
[ Cask ] : https://github.com/cask/cask
58
63
[ MELPA ] : http://melpa.milkbox.net
59
64
[ MELPA Stable ] : http://melpa-stable.milkbox.net
65
+ [ MELPA-badge ] : http://melpa.org/packages/flycheck-rust-badge.svg
66
+ [ MELPA-link ] : http://melpa.org/#/flycheck-rust
67
+ [ flycheck-inline ] : https://github.com/flycheck/flycheck-inline
68
+ [ travis-badge ] : https://travis-ci.org/flycheck/flycheck-rust.svg?branch=master
69
+ [ travis-url ] : https://travis-ci.org/flycheck/flycheck-rust
0 commit comments