Skip to content

Commit

Permalink
docs: minor README wording change
Browse files Browse the repository at this point in the history
  • Loading branch information
andelf committed Mar 31, 2024
1 parent 0b52d7c commit 30e3ec6
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ch32-data

ch32-data is a project aiming to produce clean machine-readable data about the WCH's 32-bit microcontroller families.
ch32-data is a project that aims to provide structured, machine-readable data for WCH's 32-bit microcontrollers.

This project is highly inspired by the [stm32-data](https://github.com/embassy-rs/stm32-data) project.
With the following modifications:
Expand All @@ -11,7 +11,7 @@ With the following modifications:
## Data sources

- Datasheets are provided by [wch.cn](https://www.wch.cn/) and [wch-ic.com](https://wch-ic.com/)
- SVD files are provided by [](https://www.mounriver.com/)
- SVD files are provided by [MounRiver Studio](https://www.mounriver.com/)
- SVD files are post-processed by [ch32-rs](https://github.com/ch32-rs/ch32-rs) project, adding fixes and patches
- Misc info is retrieved from <https://github.com/openwch>

Expand All @@ -20,17 +20,20 @@ With the following modifications:
- CH32V
- CH32X
- CH32L
- CH57x/CH58x/CH59x
- CH569/CH565
- CH641
- CH643
- CH645
- CH641

Not implemented yet(planing to implement using another crate):

- CH57x/CH58x/CH59x
- CH569/CH565

## Minimum supported Rust version(MSRV)

This project is developed with a recent **nightly** version of Rust compiler. And is expected to work with beta versions of Rust.

Feel free to change this if you did some testing with older versions of Rust.
Feel free to change this if you did some testing with some version of Rust.

## Contributing

Expand Down

0 comments on commit 30e3ec6

Please sign in to comment.