Skip to content

Commit 781a588

Browse files
committed
docs(readme): Be a bit more minimal in the README
The dev workflow is fairly common. The description is relatively redundant. The big seller is the screenshot. Maybe we add a slice of code at some point.
1 parent 67732cb commit 781a588

File tree

1 file changed

+0
-16
lines changed

1 file changed

+0
-16
lines changed

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,6 @@
66
[![documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
77
![build status](https://github.com/rust-lang/annotate-snippets-rs/actions/workflows/ci.yml/badge.svg)
88

9-
The library helps visualize meta information annotating source code slices.
10-
It takes a data structure called `Snippet` on the input and produces a `String`
11-
which may look like this:
12-
139
![Screenshot](./examples/expected_type.svg)
1410

15-
Local Development
16-
-----------------
17-
18-
```console
19-
$ cargo build
20-
$ cargo test
21-
```
22-
23-
When submitting a PR please use [`cargo fmt`][] (nightly).
24-
25-
[`cargo fmt`]: https://github.com/rust-lang/rustfmt
26-
2711
[Documentation]: https://docs.rs/annotate-snippets/

0 commit comments

Comments
 (0)