k230 canmv release v0.1

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# 贡献指南
+
+首先感谢您参与本开源项目，在您提交issue和pull request之前请认真阅读本指南
+
+在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue</br>
+关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考[Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
+
+issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考[GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github)
+
+## 提交issue
+
+1. 打开issue界面 https://github.com/kendryte/k230_canmv/issues
+2. 查看issue列表中是否已经存在相似issue，如果没有请点击`New issue`按钮
+3. 根据您的问题类型，选择不同的issue模板
+4. 填写必须项后(带红色\*标记)，点击`Submit new issue`按钮完成提交
+
+## 提交pull request
+
+1. Fork本仓库到您的github
+2. Clone仓库到您本地
+3. 您可以基于`main`分支创建新分支并添加更改`git checkout -b newbranch -l main`
+4. 提交您的更改到您的github
+5. 进入您的github仓库点击`Pull request`按钮后点击`New pull request`按钮
+6. 选择`base repository`为`kendryte/k230_canmv`，选择`base`为`dev`，选择`head repository`为`yourname/k230_canmv`，选择`compare`为`newbranch`
+7. 根据pull request模板要求填写您的描述
+8. 点击`Create pull request`完成提交
+
+> 如果您对以上流程还有不清楚的地方请参考[GitHub PR Flow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
+

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug report
+description: 向我们反馈您发现的Bug
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - wuwentao
+  - zhangxiaojingCAN
+  - kexinliang666
+  - chenhb3 
+body:
+  - type: textarea
+    id: what_happened
+    attributes:
+      label: What happened
+      description: Bug现象
+      placeholder: A clear and concise description of what you see, example LCD not display. (请简洁清晰的描述一下您看到的现象,比如屏幕不显示)
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction_steps
+    attributes:
+      label: Reproduction steps
+      description: 复现步骤
+      placeholder: How do you trigger this bug? Please walk us through it step by step. (您是如何触发这个bug的,请描述一下步骤)
+    validations:
+      required: true
+  - type: input
+    id: hw_version
+    attributes:
+      label: Hardware board
+      description: 硬件板卡
+      placeholder: k230 evb board
+      value: k230 evb board
+    validations:
+      required: false
+  - type: input
+    id: sw_version
+    attributes:
+      label: Software version
+      description: 软件版本
+      placeholder: v1.0 or git id
+    validations:
+      required: false
+  - type: input
+    id: bug_frequency
+    attributes:
+      label: Bug frequency
+      description: Bug复现频率
+      placeholder: occur 1-2 times per 10 times. (每10次出现1-2次)
+    validations:
+      required: false
+  - type: textarea
+    id: other
+    attributes:
+      label: Anything else
+      description: 其它信息
+      placeholder: |
+        log or image? Anything that will give us more context about the bug. (向我们提供关于bug的任何其它信息,图片或log)
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或log)
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Canaan Official Website
+    about: Canaan 官方网站
+    url: https://www.canaan-creative.com/
+  - name: Kendryte Community
+    about: Kendryte 开发者社区
+    url: https://developer.canaan-creative.com/

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature request
+description: 向我们建议您想要的Feature
+title: "[Feature]: "
+labels: ["feature"]
+assignees:
+  - wuwentao
+  - zhangxiaojingCAN
+  - kexinliang666
+  - chenhb3 
+body:
+  - type: textarea
+    id: what_feature
+    attributes:
+      label: Feature description
+      description: Feature说明
+      placeholder: A clear and concise description of feature. (请简洁清晰的描述一下您想要的feature)
+    validations:
+      required: true
+  - type: textarea
+    id: why_want
+    attributes:
+      label: Want resolve what problem
+      description: 想要解决什么问题
+      placeholder: I need this feature to solve the xx problem or my xx application needs to be based on this feature. (我需要这个feature解决xx问题或者我xx的应用需要基于这个feature)
+    validations:
+      required: false
+  - type: textarea
+    id: other
+    attributes:
+      label: Anything else
+      description: 其它信息
+      placeholder: |
+        Add any other infomation about the feature request here. (关于feature的任何其它信息)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/help.yml

@@ -0,0 +1,20 @@
+name: Help
+description: 向我们寻求帮助
+title: "[help]: "
+labels: ["help"]
+assignees:
+  - wuwentao
+  - zhangxiaojingCAN
+  - kexinliang666
+  - chenhb3 
+body:
+  - type: textarea
+    id: help
+    attributes:
+      label: Help
+      description: 帮助
+      placeholder: |
+        A clear and concise description of your problem. (请简洁清晰的描述一下您遇到的问题)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,20 @@
+name: Other
+description: 其它问题
+title: "[other]: "
+labels: []
+assignees:
+  - wuwentao
+  - zhangxiaojingCAN
+  - kexinliang666
+  - chenhb3 
+body:
+  - type: textarea
+    id: other
+    attributes:
+      label: Other
+      description: 其它问题
+      placeholder: |
+        If you have any other questions you can describe them here. (如果您有任何其它问题可以在这里描述)
+        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. (您能点击这个区域然后拖动文件来添加图片或文件)
+    validations:
+      required: true

.github/pull_request_template.md

@@ -0,0 +1,23 @@
+<!--
+请按照以下要求填写此PR模板
+1. 根据此PR的类型在右侧'Labels'位置添加对应的label。比如此PR修复了某个bug，则添加'bug'label；此PR新增了某个feature，则添加'feature'label。
+2. 在'PR描述'项里填写此PR解决了什么问题，比如修复了某个bug或新增了某个feature。
+3. 在'详细描述'项里根据PR类型填写详细信息。比如此PR修复了某个bug，则填写bug的根本原因，您是如何解决的；此PR新增了某个feature，则填写您是如何实现的。
+4. 在'关联issue'项里填写相关issue号(输入'#'会自动提示issue)，推荐使用'close'、'fix'、'resolve'等关键字进行自动关联(如'fix #1')，也可以提交PR后在右侧'Development'中进行手动关联。
+-->
+
+## PR描述:
+
+
+## 详细描述:
+
+
+## 关联issue:
+
+fix #X
+
+<!--
+请将#之后的X，手动修改为PR关联的issue ID, PR合并成功后，可以自动关闭对应的issue
+Example: 
+fix #1
+-->

.gitignore

@@ -7,11 +7,10 @@
 # for more information.
 
 # Build directories
-build/
-build-*/
+output/
+.read*
+.conf
 
 # Python cache files
 __pycache__
-
-.read*
-.sync*
+.vscode/