Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Neutree committed Nov 28, 2024
1 parent 037ee23 commit d9cee38
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
12 changes: 11 additions & 1 deletion docs/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ MaixCDK is not only a C++ SDK but also auto-generates Python API bindings, so de

Basic Linux knowledge and a fundamental understanding of cross-compilation are required to use MaixCDK.

## Basic Knowledge

To use MaixCDK, it is assumed that you are already familiar with the following knowledge. If not, please learn them first or consider using [MaixPy](https://wiki.sipeed.com/maixpy/):

* Proficient in using Linux for development, familiar with the terminal and common commands.
* Proficient in either C or C++ programming language. C++ proficiency is not required, but you must understand the basic syntax and object-oriented concepts.
* Able to actively read and analyze source code to troubleshoot issues.
* Chinese developers should be familiar with using network proxies.
* Understand cross-compilation.


## How to Find Resources and Troubleshoot

1. Read [MaixCDK source code](https://github.com/sipeed/MaixCDK).
Expand Down Expand Up @@ -90,7 +101,6 @@ After the compilation, you will find the binary program files in the `build` dir

After modifying the code, you can run `maixcdk build` again to compile.

The `maixcdk build` command will scan all files for changes and rebuild them by default.
If you **haven’t added or removed source files**, you can run `maixcdk build2` or `maixcdk build --no-gen` for faster compilation (it will only compile the modified files).
> This is because the `build` command starts the entire build process from scratch, scanning files and recompiling. In contrast, the `build2` command will not scan for file additions or deletions and will only compile the edited files.
> Note: The `build2` command will not detect file additions or deletions, so if you **add or remove files**, you must run the `build` command again.
Expand Down
10 changes: 9 additions & 1 deletion docs/doc_zh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ MaixCDK 不光是一套 C++ SDK,同时会自动生成 Python API 绑定,即

使用 MaixCDK 需要基本的 Linux 使用经验和懂交叉编译的基本概念。

## 基础知识

要使用 MaixCDK,均假设你已经会以下知识,不会请先自行学习或者请转角使用[MaixPy](https://wiki.sipeed.com/maixpy/)
* 熟练使用 Linux 进行开发,熟悉终端以及常见命令使用。
* 熟练掌握 C/C++ 其中一种语言,其中 C++ 可以不熟练但是必须了解基础语法和面向对象概念。
* 会主动看源码分析问题。
* 中国开发者须了解使用网络代理。
* 了解交叉编译。


## 如何找资料和解决问题

Expand Down Expand Up @@ -95,7 +104,6 @@ maixcdk build

修改了代码后,再次执行`maixcdk build`即可编译。

`maixcdk build` 命令默认会扫描所有文件更改再构建,
如果你**没有增删源码文件可以执行`maixcdk build2` 或者 `maixcdk build --no-gen` 编译会更快**(只编译修改了的文件)。
> 因为`build`命令会从头开始构建,扫描文件再编译,`build2`命令则不会扫描文件增删,直接编译编辑过的文件。
> 注意`build2`命令不会检测到文件增加或者删除,如果**增删了文件必须再执行一遍`build`命令**
Expand Down

0 comments on commit d9cee38

Please sign in to comment.