Skip to content

Commit

Permalink
Doc: Add note about rustc version 1.70
Browse files Browse the repository at this point in the history
  • Loading branch information
coastalwhite committed Jun 23, 2023
1 parent 6b4c4d9 commit 5b619a8
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ homepage = "https://github.com/coastalwhite/wavedrom-rs"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "A Pure Rust Digital Timing Diagram Generator based on WaveDrom-JS"
rust-version = "1.70"

[workspace.dependencies]
clap = "4.3.2"
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ cd ./tests
./run [path/to/skin.json5]
```

## MSRV

This crate currently only compiles with Rust 1.70. To select that version use:

```bash
rustup update 1.70 --no-self-update && rustup default 1.70
```

## Contribution

Please report any bugs and possible improvements as an issue within this
Expand Down
1 change: 1 addition & 0 deletions mdbook-wavedrom-rs/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors.workspace = true
repository.workspace = true
homepage.workspace = true
edition.workspace = true
rust-version.workspace = true
license = "MPL-2.0"

keywords = ["diagram", "svg", "signal", "digital", "timing"]
Expand Down
3 changes: 2 additions & 1 deletion mdbook-wavedrom-rs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Integration for [wavedrom-rs] with [mdbook].
First, install the preprocessor utilizing the [Rust Toolchain].

```bash
cargo install mdbook-wavedrom-rs
# Enable version 1.70 for rustc
cargo +1.70 install mdbook-wavedrom-rs
```

Then, add the preprocessor to the list of preprocessors in your [mdbook]
Expand Down
1 change: 1 addition & 0 deletions wavedrom-wasm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ repository.workspace = true
homepage.workspace = true
edition.workspace = true
license.workspace = true
rust-version.workspace = true

description = "A WASM interface for WaveDrom Digital Timing Diagrams"

Expand Down
1 change: 1 addition & 0 deletions wavedrom/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ homepage.workspace = true
edition.workspace = true
license.workspace = true
description.workspace = true
rust-version.workspace = true

keywords = ["diagram", "svg", "signal", "digital", "timing"]
categories = ["graphics", "visualization", "wasm"]
Expand Down

0 comments on commit 5b619a8

Please sign in to comment.