Skip to content

Commit 4b3d37e

Browse files
committed
add description
1 parent f14a216 commit 4b3d37e

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* [Introduction](https://github.com/openwch/arduino_core_ch32#Introduction)<br>
44
* [How to use](https://github.com/openwch/arduino_core_ch32#How-to-use)<br>
55
* [Supported boards](https://github.com/openwch/arduino_core_ch32#Supported-boards)<br>
6+
* [OS support](https://github.com/openwch/arduino_core_ch32#OS-support)<br>
67
* [Submit bugs](https://github.com/openwch/arduino_core_ch32#Submit-bugs)<br>
78

89
## Introduction
@@ -64,6 +65,50 @@ It will be a long-term support and maintenance project, unless we encounter forc
6465
| :----: | ---- | ---- | :-----: | :---- |
6566
| :heavy_check_mark: | CH32V307VCT6_BLACK | ADC,DAC,USART,GPIO,EXTI,SysTick,SPI,I2C_Master | 1.0.3 | - |
6667

68+
69+
## OS support
70+
71+
Adopting toolchain and openocd under [MRS](http://www.mounriver.com/), supporting HPE, custom byte and half-word compression extensions,"upload" via WCH_LINKE.
72+
73+
**Most importantly, the version of Arduino IDE is 2.0+.**
74+
75+
### Win
76+
77+
If you encounter an error during upload, please confirm that the version of your WCH-LINKE is consistent with the latest version under MRS.
78+
WCH-LINKE related information can [refer to this link](https://github.com/openwch/ch32v307/tree/main/WCH-Link).
79+
80+
### Linux
81+
82+
For Linux, after installing the support package for the first time, to ensure the normal upload function,
83+
please open the packages installation path of the Arduino IDE, run the script, and automatically configure the environment.
84+
85+
Usually, it can be operated as follows:<br>
86+
87+
```bash
88+
cd ~/.arduino15/packages/WCH/tools/beforeinstall/1.0.0
89+
./start.sh
90+
```
91+
After authorization, it will copy or generate some necessary libraries and rules:
92+
93+
```text
94+
Copy Libs
95+
[sudo] password for temperslee:
96+
Register new Libs
97+
copy rules
98+
Reload rules
99+
DONE
100+
```
101+
102+
### MAC
103+
104+
For MAC, please install the "libusb" library before starting to use it.
105+
```bash
106+
brew install libusb
107+
```
108+
If "libusb" related errors still occur when "uploading" firmware after installing the libusb library,
109+
please contact the **MRS team** for assistance through "*[email protected]*".
110+
111+
67112
## Submit bugs
68113

69114
If you have any questions, you could contact me through the email "*[email protected]*".

0 commit comments

Comments
 (0)