Skip to content

Commit

Permalink
Merge branch 'update_readme' into 'dev'
Browse files Browse the repository at this point in the history
update readme with image download info

See merge request maix_sw/k230_canmv!179
  • Loading branch information
zzxcanaan committed Feb 2, 2024
2 parents 2aa4a5d + 5a02523 commit 87b2b5b
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Expand Up @@ -4,9 +4,18 @@

CanMV 的目的是让 AIOT 编程更简单, 基于 [Micropython](http://www.micropython.org) 语法, 运行在[Canaan](https://www.canaan-creative.com/)强大的嵌入式AI SOC系列上。目前它在K230上运行。

## 镜像下载

1. **[main branch](https://github.com/kendryte/k230_canmv/tree/main)**: Github默认分支,作为release分支,编译release镜像自动发布至[Release](https://github.com/kendryte/k230_canmv/releases)页面
2. **[dev branch](https://github.com/kendryte/k230_canmv/tree/dev)**: Github开发分支,仅供测试,镜像可通过[GitHub Actions](https://github.com/kendryte/k230_canmv/actions)页面下载`dev`分支中不同commit id对应的artifacts产物,*默认缓存90天*
3. 预编译release镜像:请访问[嘉楠开发者社区](https://developer.canaan-creative.com/resource), 然后在`K230/Images`分类中,下载镜像文件名包含`micropython`的文件,并烧录至SD卡中。(镜像文件名格式:`CanMV-K230_micropython_*.img.gz`)

> 下载的镜像默认为`.gz`压缩格式,需先解压缩,然后再烧录。
> micropython镜像与K230 SDK镜像所支持的功能并不相同,请勿下载K230 SDK镜像来使用micropython
## 快速开始

### 编译
### 自行编译镜像

```sh
git clone k230_canmv
Expand All @@ -24,7 +33,7 @@ make

### 烧录

linux下直接使用dd命令进行烧录,windows下使用烧录工具进行烧录
linux下直接使用dd命令进行烧录,windows下使用烧录工具进行烧录,可参考[K230 SDK烧录镜像文件](https://github.com/kendryte/k230_sdk?tab=readme-ov-file#%E7%83%A7%E5%BD%95%E9%95%9C%E5%83%8F%E6%96%87%E4%BB%B6)

### 获取更新

Expand Down

0 comments on commit 87b2b5b

Please sign in to comment.