Skip to content

Commit 1ffbbfe

Browse files
committed
Improve README, add MELPA badge
1 parent a722204 commit 1ffbbfe

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

+20-10
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
flycheck-rust — Flycheck for Rust
22
=================================
33

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]
55
[![License GPL 3][badge-license]][copying]
6+
[![MELPA][MELPA-badge]][MELPA-link]
67

7-
Configure [Flycheck][] for Rust.
8+
This Flycheck extension configures Flycheck automatically for the current
9+
Cargo project.
810

9-
- Setup Flycheck to follow the Cargo project layout.
10-
11-
Installation
12-
------------
11+
Setup
12+
-----
1313

14-
As usual, from [MELPA][] or [MELPA Stable][].
14+
Install from [MELPA][] or [MELPA Stable][].
1515

16-
In your [`Cask`][cask] file:
16+
If you use [`Cask`][cask]:
1717

1818
```emacs-lisp
1919
(source gnu)
@@ -22,7 +22,7 @@ In your [`Cask`][cask] file:
2222
(depends-on "flycheck-rust")
2323
```
2424

25-
In your `init.el`:
25+
Then, in your `init.el`:
2626

2727
```emacs-lisp
2828
(with-eval-after-load 'rust-mode
@@ -32,7 +32,12 @@ In your `init.el`:
3232
Usage
3333
-----
3434

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.
3641

3742
License
3843
-------
@@ -57,3 +62,8 @@ See [`COPYING`][copying] for details.
5762
[Cask]: https://github.com/cask/cask
5863
[MELPA]: http://melpa.milkbox.net
5964
[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

Comments
 (0)