diff --git a/README.md b/README.md index 9e67457..7dc5b85 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ * [Introduction](https://github.com/openwch/arduino_core_ch32#Introduction)
* [How to use](https://github.com/openwch/arduino_core_ch32#How-to-use)
* [Supported boards](https://github.com/openwch/arduino_core_ch32#Supported-boards)
+* [OS support](https://github.com/openwch/arduino_core_ch32#OS-support)
* [Submit bugs](https://github.com/openwch/arduino_core_ch32#Submit-bugs)
## Introduction @@ -64,6 +65,50 @@ It will be a long-term support and maintenance project, unless we encounter forc | :----: | ---- | ---- | :-----: | :---- | | :heavy_check_mark: | CH32V307VCT6_BLACK | ADC,DAC,USART,GPIO,EXTI,SysTick,SPI,I2C_Master | 1.0.3 | - | + +## OS support + +Adopting toolchain and openocd under [MRS](http://www.mounriver.com/), supporting HPE, custom byte and half-word compression extensions,"upload" via WCH_LINKE. + +**Most importantly, the version of Arduino IDE is 2.0+.** + +### Win + +If you encounter an error during upload, please confirm that the version of your WCH-LINKE is consistent with the latest version under MRS. +WCH-LINKE related information can [refer to this link](https://github.com/openwch/ch32v307/tree/main/WCH-Link). + +### Linux + +For Linux, after installing the support package for the first time, to ensure the normal upload function, +please open the packages installation path of the Arduino IDE, run the script, and automatically configure the environment. + +Usually, it can be operated as follows:
+ +```bash +cd ~/.arduino15/packages/WCH/tools/beforeinstall/1.0.0 +./start.sh +``` +After authorization, it will copy or generate some necessary libraries and rules: + +```text +Copy Libs +[sudo] password for temperslee: +Register new Libs +copy rules +Reload rules +DONE +``` + +### MAC + +For MAC, please install the "libusb" library before starting to use it. +```bash +brew install libusb +``` +If "libusb" related errors still occur when "uploading" firmware after installing the libusb library, +please contact the **MRS team** for assistance through "*support@mounriver.com*". + + ## Submit bugs If you have any questions, you could contact me through the email "*yy@wch.cn*".