Skip to content

Commit

Permalink
publish maixcdk docs to sipeed wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Neutree committed Nov 8, 2024
1 parent 67cdc72 commit 83ad7d2
Show file tree
Hide file tree
Showing 58 changed files with 3,527 additions and 554 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/build_linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,13 @@ jobs:
cd test/test_examples
chmod +x test_cases.sh
./test_cases.sh linux 0
- name: Build doc
run: |
pip3 install teedoc
cd docs
echo "== install plugins =="
teedoc install
echo "== start build =="
teedoc build
echo "== build complete =="
10 changes: 10 additions & 0 deletions .github/workflows/build_maixcam.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,13 @@ jobs:
cd ../../projects
chmod +x build_all.sh
./build_all.sh
- name: Build doc
run: |
pip3 install teedoc
cd docs
echo "== install plugins =="
teedoc install
echo "== start build =="
teedoc build
echo "== build complete =="
89 changes: 89 additions & 0 deletions .github/workflows/build_maixcam_pulish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# This is a basic workflow to help you get started with Actions

name: Build test for MaixCAM

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [ main ]
# pull_request:
# branches: [ main ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions: write-all

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# Only run job for specific repository
if: github.repository == 'sipeed/MaixCDK'
# The type of runner that the job will run on
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.11"] # MaixCAM use 3.11
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Build MaixCDK Examples
run: |
echo "-- Check python version must python 3.11 --"
python3 -c 'import sys;print(sys.version);assert sys.version_info >= (3, 11);assert sys.version_info < (3, 12)'
python -c 'import sys;print(sys.version);assert sys.version_info >= (3, 11);assert sys.version_info < (3, 12)'
whereis python
whereis python3
# export PATH=~/.local/bin/:$PATH
echo "--------------------------------"
echo "-- Install requirements first --"
echo "--------------------------------"
python -m pip install -r requirements.txt
echo "--------------------------------"
echo "-- Build Test for MaixCAM now --"
echo "--------------------------------"
cd test/test_examples
chmod +x test_cases.sh
./test_cases.sh maixcam 0
echo "------------------------------------"
echo "-- Build Projects for MaixCAM now --"
echo "------------------------------------"
cd ../../projects
chmod +x build_all.sh
./build_all.sh
- name: Push doc to github pages
run: |
pip3 install teedoc
cd docs
echo "== install plugins =="
teedoc install
echo "== start build =="
teedoc build
echo "== build complete =="
remote_addr=`git remote get-url --push origin`
remote_addr=`echo $remote_addr| awk -F'://' '{print $2}'`
user_name=`git log -1 --pretty=format:'%an'`
user_email=`git log -1 --pretty=format:'%ae'`
echo "== checkout gh-pages branch =="
cd out
cp -r ../../.github .
git config --global init.defaultBranch gh-pages
git init
git config user.name "${user_name}"
git config user.email ${user_email}
remote_addr="https://Neutree:${{ secrets.DISPATCH_PAT }}@${remote_addr}"
echo "-- user ${user_name}"
echo "-- remote addr: ${remote_addr}"
git remote add origin "${remote_addr}"
echo "== add web files =="
git add -A
git commit -m "Rebuild MaixPy doc by commit $GITHUB_REF"
git push origin HEAD:gh-pages --force
echo "== push complete =="
48 changes: 48 additions & 0 deletions .github/workflows/sync_gitee.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# This is a basic workflow to help you get started with Actions

name: sync code to gitee

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
# on:
# push:
# branches: [ master ]
# pull_request:
# branches: [ master ]
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [ main ]
# pull_request:
# branches: [ main ]


# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
sync_gitee:
name: sync repo to gitee
# Only run job for specific repository
if: github.repository == 'sipeed/MaixCDK'
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: checkout code from github
uses: actions/checkout@v2

# Runs a set of commands using the runners shell
- name: sync shell cmd
run: |
GITEE_GIT_ADDR="[email protected]:Sipeed/MaixCDK.git"
git fetch --unshallow
SSHPATH="$HOME/.ssh"
rm -rf "$SSHPATH"
mkdir -p "$SSHPATH"
echo "${{ secrets.GITEE_SYNC_ACCESSS_KEY }}" > "$SSHPATH/id_rsa"
chmod 600 "$SSHPATH/id_rsa"
sudo sh -c "echo StrictHostKeyChecking no >>/etc/ssh/ssh_config"
git remote add upstream $GITEE_GIT_ADDR
git push upstream main:main --force
45 changes: 45 additions & 0 deletions .github/workflows/trigger_wiki.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# This is a basic workflow to help you get started with Actions

name: trigger wiki

# Controls when the action will run.
on:
push:
branches:
- gh-pages
pull_request:
branches:
- gh-pages

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions: write-all

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
trigger_wiki:
name: trigger sipeed_wiki
# Only run job for specific repository
# if: github.repository == 'sipeed/MaixPy'
# The type of runner that the job will run on
runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: [3.8]

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: trigger sipeed wiki request
uses: actions/github-script@v6
with:
github-token: ${{ secrets.DISPATCH_PAT }}
script: |
const result = await github.rest.repos.createDispatchEvent({
owner: 'sipeed',
repo: 'sipeed_wiki',
event_type: 'update_maixcdk_doc',
client_payload: {"key": "value"}
})
console.log(result);
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
MaixCDK
===

<div align="center">

![](https://wiki.sipeed.com/maixcdk/static/image/maixcams.png)


<h2>MaixCDK: 快速落地 AI 视觉、听觉应用</h2>

**Let's Sipeed up, Maximize AI's power!**

<h3>
<a href="https://wiki.sipeed.com/maixcdk/doc/index.html"> Quick Start </a> |
<a href="https://wiki.sipeed.com/maixcdk/index.html"> Documentation </a> |
<a href="https://wiki.sipeed.com/maixcdk/api/index.html"> API </a> |
<a href="https://wiki.sipeed.com/maixcam-pro"> Hardware </a> |
<a href="https://maixhub.com/app"> APP Store </a>
</h3>

[![GitHub Repo stars](https://img.shields.io/github/stars/sipeed/MaixCDK?style=social)](https://github.com/sipeed/MaixCDK/stargazers)
[![Apache 2.0](https://img.shields.io/badge/license-Apache%20v2.0-orange.svg)]("https://github.com/sipeed/MaixCDK/blob/main/LICENSE.md)
![GitHub repo size](https://img.shields.io/github/repo-size/sipeed/MaixCDK)
[![Build MaixCAM](https://github.com/sipeed/MaixCDK/actions/workflows/build_maixcam.yml/badge.svg)](https://github.com/sipeed/MaixCDK/actions/workflows/build_maixcam.yml)
[![Trigger wiki](https://github.com/sipeed/MaMaixCDKixPy/actions/workflows/trigger_wiki.yml/badge.svg)](https://github.com/sipeed/MaixCDK/actions/workflows/trigger_wiki.yml)

[English](./README.md) | 中文

</div>


English | [中文](./README_ZH.md)


Expand All @@ -27,12 +55,13 @@ For more information, refer to the [MaixPy](https://github.com/sipeed/MaixPy) in

| Device | Support Status |
| ------ | -------------- |
| Linux | Partial |
| [Sipeed MaixCAM](https://wiki.sipeed.com/maixcam) | Full |
| [Sipeed MaixCAM-Pro](https://wiki.sipeed.com/maixcam-pro) | Full |
| Commen Linux | Partial |

## Quick Start

Click to view the [Quick Start](./docs/doc/dev/quick_start.md) document, which includes instructions on how to quickly download code, compile, and run.
Click to view the [Quick Start](./docs/doc/README.md) document, which includes instructions on how to quickly download code, compile, and run.

## MaixCDK Development Guidelines

Expand All @@ -42,6 +71,8 @@ To help developers quickly understand MaixCDK and maintain the quality of long-t

In addition to the development guidelines above, the documentation also includes application documents, development notes, and more for reference.

Please visit [Sipeed Wiki](https://wiki.sipeed.com/maixcdk).

The documents are written in `Markdown` format under the [docs](./docs) directory. You can directly view the `.md` files or generate a web version of the documentation using the [teedoc](https://github.com/teedoc/teedoc) tool.

```shell
Expand Down
40 changes: 34 additions & 6 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,41 @@
MaixCDK
===================

<div align="center">

![](https://wiki.sipeed.com/maixcdk/static/image/maixcams.png)


<h2>MaixCDK: 快速落地 AI 视觉、听觉应用</h2>

**Let's Sipeed up, Maximize AI's power!**

<h3>
<a href="https://wiki.sipeed.com/maixcdk/doc/index.html"> 快速开始 </a> |
<a href="https://wiki.sipeed.com/maixcdk/index.html"> 文档 </a> |
<a href="https://wiki.sipeed.com/maixcdk/api/index.html"> API </a> |
<a href="https://wiki.sipeed.com/maixcam-pro"> 硬件 </a> |
<a href="https://maixhub.com/app"> 应用商店 </a>
</h3>

[![GitHub Repo stars](https://img.shields.io/github/stars/sipeed/MaixCDK?style=social)](https://github.com/sipeed/MaixCDK/stargazers)
[![Apache 2.0](https://img.shields.io/badge/license-Apache%20v2.0-orange.svg)]("https://github.com/sipeed/MaixCDK/blob/main/LICENSE.md)
![GitHub repo size](https://img.shields.io/github/repo-size/sipeed/MaixCDK)
[![Build MaixCAM](https://github.com/sipeed/MaixCDK/actions/workflows/build_maixcam.yml/badge.svg)](https://github.com/sipeed/MaixCDK/actions/workflows/build_maixcam.yml)
[![Trigger wiki](https://github.com/sipeed/MaMaixCDKixPy/actions/workflows/trigger_wiki.yml/badge.svg)](https://github.com/sipeed/MaixCDK/actions/workflows/trigger_wiki.yml)

[English](./README.md) | 中文

</div>


MaixCDK(Maix C/CPP Development Kit) 是集成了 AI + 机器视觉 + IOT 等实用功能的 C/C++ 开发套件,简单易用的封装,让你快速构建自己的视觉、人工智能、IOT、机器人、工业相机等项目。

也是 [MaixPy](https://github.com/sipeed/MaixPy) 的 C/C++ 版本。

## 特性

* 支持 AI 模型硬件加速运行,支持常见 分类、检测、分割算法
* 支持 AI 模型硬件加速运行,支持常见 分类、检测、分割、跟踪等算法
* 支持常用视觉算法,比如 找色块、二维码、apriltag、巡线等等。
* 支持 OpenCV。
* 常用外设操作(UART、IIC、SPI、GPIO、PWM、ADC、摄像头、屏幕等)。
Expand All @@ -28,22 +53,25 @@ MaixCDK(Maix C/CPP Development Kit) 是集成了 AI + 机器视觉 + IOT 等实

| 设备名 | 支持状态 |
| ----- | ------- |
| Linux | 部分支持 |
| [Sipeed MaixCAM](https://wiki.sipeed.com/maixcam) | 完全支持 |
| [Sipeed MaixCAM-Pro](https://wiki.sipeed.com/maixcam-pro) | 完全支持 |
| 通用 Linux | 部分支持 |


## 快速开始

点击查看 [快速开始](./docs/doc/dev/quick_start.md) 文档,里面包含了如何快速下载代码、编译、运行
点击查看 [快速开始](./docs/doc_zh/README.md) 文档,里面包含了如何快速下载代码、编译、运行

## MaixCDK 开发准则

为帮助开发者快速了解 MaixCDK, 以及保持长期更新的质量,在 编写 或 贡献 代码前,请务必阅读 [MaixCDK 开发准则和指导](./docs/doc/convention/README.md)
为帮助开发者快速了解 MaixCDK, 以及保持长期更新的质量,在 编写 或 贡献 代码前,请务必阅读 [MaixCDK 开发准则和指导](./docs/doc_zh/convention/README.md)


## 更多文档

出了上面的开发准则,文档里面还有应用文档,开发笔记等供查阅。
除了上面的开发准则,文档里面还有应用文档,开发笔记等供查阅。

请访问 [Sipeed Wiki](https://wiki.sipeed.com/maixcdk) 在线查看。

文档在[docs](./docs)目录下,使用`Markdown`格式编写,可以直接查看`.md`文件,
也可以使用[teedoc](https://github.com/teedoc/teedoc)工具生成网页版文档。
Expand All @@ -63,7 +91,7 @@ teedoc serve # 启动一个本地网页服务用以预览

## 常见问题

在编译或者使用时遇到问题,首先看下[FAQ](./docs/doc/faq.md)是否有解决方案。
在编译或者使用时遇到问题,首先看下[FAQ](./docs/doc_zh/faq.md)是否有解决方案。


## 开源协议
Expand Down
Loading

0 comments on commit 83ad7d2

Please sign in to comment.