Skip to content

Repository files navigation

board-docs

中文 / English

Welcome to the RuyiSDK development board tutorial and example documentation center. This repository mainly contains environment initialization guides, getting-started examples, peripheral control, multimedia, AI, and other tutorial documents for various RISC-V development boards.

📚 Directory Structure

  • /<board-name>: Stores tutorial documents and examples categorized by development board model (in Markdown format).
  • /templates: Stores documentation templates for adding new boards and examples.

🚀 Supported Development Board Matrix

This repository currently includes, but is not limited to, documentation resources for the following hardware:

Supported Device Board Documentation Chip Vendor
Banana Pi BPI-F3 BPI-F3 SpacemiT
BPI-CANMV-K230D-Zero BPI-CANMV-K230D-Zero Canaan
Canaan K510-CRB-V1.2 KIT K510 Canaan
EBC7700 EBC7700 ESWIN
ESP32-P4-Function-EV-Board ESP32-P4 Espressif
Lichee Pi 3A LicheePi3A SpacemiT
Lichee Pi 4A LicheePi4A XuanTie
Milk-V Duo (256M) Duo_256m SOPHGO
Milk-V Duo (64M) Duo SOPHGO
Milk-V Duo S Duo_S SOPHGO
Milk-V Jupiter2 Jupiter2 SpacemiT
Milk-V Meles Meles XuanTie
Milk-V Pioneer Pioneer SOPHGO
Nuclei RV-STAR RV-STAR GigaDevice
SpacemiT K3 Pico-ITX K3-Pico-ITX SpacemiT
VisionFive 2 Lite VisionFive2Lite StarFive

(Note: For the complete list of boards and examples, please visit the board documentation frontend.)

🛠️ How to Contribute

We warmly welcome developers or interns to submit new development board evaluations or improve existing documentation. Please follow the steps below:

  1. Fork this repository and clone it locally.
  2. Use templates: Use the standard documentation templates in templates/ and fill in the initialization process and test results as required.
  3. Format check: Ensure correct Markdown syntax, and pay special attention to checking for broken links.
  4. Submit a PR: Clearly describe the development board model you tested and the toolchain version used in the PR description.

📄 License

  • All documentation and tutorial content in this repository is licensed under the CC BY 4.0 License. Please provide proper attribution when redistributing or modifying.
  • All example code and scripts in this repository are licensed under the Apache 2.0 License.

About

Documents for develop boards

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages