Skip to content

Commit

Permalink
Add more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
novafacing committed Sep 1, 2023
1 parent e17fc0d commit 81520c3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .cargo/config.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
[env]
# NOTE: Required for this crate, because all the tests are running Yices2 code that cannot
# be safely threaded or run in parallel
RUST_TEST_THREADS = "1"
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,12 @@ You can add this crate to your project by running:
cargo add yices2
```

Or by adding this line to your `Cargo.toml`:
Or by adding this line to your `Cargo.toml` (note the patch pseudo-prerelease flag. In
order to maintain version number compatibility with Yices2, changes to the `sys` crate
will be made available under linearly increasing patch versions):

```toml
yices2 = { version = "2.6.4" }
yices2 = { version = "2.6.4-patch.1" }
```

## Features
Expand All @@ -81,7 +83,7 @@ initialization and `yices_exit` at program exit. If you'd like to disable this b
you can use the `default-features = false` flag in your `Cargo.toml`.

```toml
yices2 = { version = "2.6.4", default-features = false }
yices2 = { version = "2.6.4-patch.1", default-features = false }
```

## Notes
Expand Down
4 changes: 2 additions & 2 deletions yices2/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
//! Or by adding this line to your `Cargo.toml`:
//!
//! ```toml
//! yices2 = { version = "2.6.4" }
//! yices2 = { version = "2.6.4-patch.1" }
//! ```
//!
//! ## Features
Expand All @@ -81,7 +81,7 @@
//! you can use the `default-features = false` flag in your `Cargo.toml`.
//!
//! ```toml
//! yices2 = { version = "2.6.4", default-features = false }
//! yices2 = { version = "2.6.4-patch.1", default-features = false }
//! ```
//!
//! ## Notes
Expand Down

0 comments on commit 81520c3

Please sign in to comment.