Skip to content

[anneal][README] Tighten wording #3328

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
joshlf merged 1 commit into from
Apr 28, 2026
+3 −5
Merged

[anneal][README] Tighten wording #3328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 anneal/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion anneal/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ members = [".", "tools/doc_gen"]
[package]
name = "cargo-anneal"
edition = "2024"
version = "0.1.0-alpha.20"
version = "0.1.0-alpha.21"
description = "Formally verify that your safety comments are correct."
categories = [
"development-tools::cargo-plugins",
Expand Down
4 changes: 1 addition & 3 deletions anneal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ impl std::ops::Div<PositiveUsize> for usize {
Install Anneal and its required toolchains (Charon and Aeneas):

```bash
cargo install cargo-anneal@0.1.0-alpha.20
cargo install cargo-anneal@0.1.0-alpha.21
cargo anneal setup
```

Expand Down Expand Up @@ -137,8 +137,6 @@ cargo anneal verify

## Usage & Commands

Anneal wraps the underlying tools to provide a seamless experience:

- **`cargo anneal verify`**: Verifies the target crate.
- **`cargo anneal expand`**: Outputs the generated Lean code without running full verification (useful for debugging).
- **`cargo anneal generate`**: Generates the `.lean` files on disk, allowing you to iterate on proofs using standard Lean tooling before copying them back to Rust source.
Loading