|
1 | 1 | # annotate-snippets |
2 | 2 |
|
3 | | -`annotate-snippets` is a Rust library for annotation of programming code slices. |
| 3 | +> Format diagnostic reports, including highlighting snippets of text |
4 | 4 | |
5 | 5 | [](https://crates.io/crates/annotate-snippets) |
6 | 6 | [][Documentation] |
7 | 7 |  |
8 | 8 |
|
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 | | - |
13 | 9 |  |
14 | 10 |
|
15 | | -Local Development |
16 | | ------------------ |
| 11 | +## License |
17 | 12 |
|
18 | | -```console |
19 | | -$ cargo build |
20 | | -$ cargo test |
21 | | -``` |
| 13 | +Licensed under either of |
22 | 14 |
|
23 | | -When submitting a PR please use [`cargo fmt`][] (nightly). |
| 15 | +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>) |
| 16 | +* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/license/mit>) |
24 | 17 |
|
25 | | -[`cargo fmt`]: https://github.com/rust-lang/rustfmt |
| 18 | +at your option. |
26 | 19 |
|
27 | 20 | [Documentation]: https://docs.rs/annotate-snippets/ |
0 commit comments