Skip to content

docs(readme): Clean up README #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2025
Merged

docs(readme): Clean up README #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67732cb
docs(readme): Be consistent in project description
epage Sep 2, 2025
781a588
docs(readme): Be a bit more minimal in the README
epage Sep 2, 2025
8655310
docs(readme): Call out licenses
epage Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ lto = true
[package]
name = "annotate-snippets"
version = "0.12.1"
description = "Library for building code annotations"
description = "Format diagnostic reports, including highlighting snippets of text"
categories = []
keywords = ["code", "analysis", "ascii", "errors", "debug"]
repository.workspace = true
Expand Down
19 changes: 6 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
# annotate-snippets

`annotate-snippets` is a Rust library for annotation of programming code slices.
> Format diagnostic reports, including highlighting snippets of text

[![crates.io](https://img.shields.io/crates/v/annotate-snippets.svg)](https://crates.io/crates/annotate-snippets)
[![documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
![build status](https://github.com/rust-lang/annotate-snippets-rs/actions/workflows/ci.yml/badge.svg)

The library helps visualize meta information annotating source code slices.
It takes a data structure called `Snippet` on the input and produces a `String`
which may look like this:

![Screenshot](./examples/expected_type.svg)

Local Development
-----------------
## License

```console
$ cargo build
$ cargo test
```
Licensed under either of

When submitting a PR please use [`cargo fmt`][] (nightly).
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/license/mit>)

[`cargo fmt`]: https://github.com/rust-lang/rustfmt
at your option.

[Documentation]: https://docs.rs/annotate-snippets/
Loading