Skip to content
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.

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

docs(README): improve documentation on how to build ch32v003 examples #84

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 examples/ch32v003/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ embassy-time = { version = "0.3.0" }

# This is okay because we should automatically use whatever ch32-hal uses
qingke = "*"
qingke-rt = { version = "*", features = ["highcode"] }
qingke-rt = { version = "0.5.0", features=["highcode"] }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. please format your code
  2. Have you tried cleaning / clean build and this is still necessary? My understanding is that * will match whatever qingke that ch32-hal uses. Which should be 0.5 in the main branch Unless you have some lock file lingering around. Please correct me if I'm mistaken about this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

1.: Sure. Is there any formatter for Cargo toml that you recommend?

2.: I just did a clean clone of the master branch so I would suspect there is nothing else around



panic-halt = "1.0"
Expand Down
7 changes: 7 additions & 0 deletions examples/ch32v003/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ Link: [OSHWHUB](https://oshwhub.com/andelf/linedog)

## Running Examples

### using rust-nightly for building

call `rustup install nightly` and `rustup override set nightly` to build this project with rust nightly,
which allows to compilation for riscv32ec using the [json-file](riscv32ec-unknown-none-elf.json) provided.

You might need to install the sources for core with `rustup component add rust-src`

### Using [wlink](https://github.com/ch32-rs/wlink)
- Install wlink using the installation instructions: https://github.com/ch32-rs/wlink?tab=readme-ov-file#install

Expand Down