diff --git a/doc/static/images/make_install.png b/doc/static/images/make_install.png new file mode 100644 index 0000000..e6da5f4 Binary files /dev/null and b/doc/static/images/make_install.png differ diff --git a/doc/zh-Hans/api.doxyfile b/doc/zh-Hans/api.doxyfile index cfbafee..83fb421 100644 --- a/doc/zh-Hans/api.doxyfile +++ b/doc/zh-Hans/api.doxyfile @@ -791,6 +791,11 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = mainpage.md \ + guides.md \ + guide_build_linux.md \ + guide_samples.md \ + guide_log.md \ + guide_opencv.md \ specs_data.md \ spec_hardware_info.md \ spec_image_params.md \ @@ -1758,7 +1763,7 @@ LATEX_EXTRA_STYLESHEET = # markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_FILES = +LATEX_EXTRA_FILES = ../static/images/make_install.png # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will diff --git a/doc/zh-Hans/guide_build_linux.md b/doc/zh-Hans/guide_build_linux.md new file mode 100644 index 0000000..05775fd --- /dev/null +++ b/doc/zh-Hans/guide_build_linux.md @@ -0,0 +1,30 @@ +# 编译 on Linux {#guide_build_linux} + +## 获取代码 + +```bash +git clone +``` + +## 准备依赖 + +```bash +cd mynt-eye-sdk-2/ +make init +``` + +## 编译代码 + +```bash +make install +``` + +结果: + +![make install](make_install.png) + +\latexonly +\includegraphics[width=0.6\textwidth,keepaspectratio]{make_install.png} +\endlatexonly + +> CMake 如何引入编译好的库,可参考 `samples/CMakeLists.txt` 里的配置。 diff --git a/doc/zh-Hans/guide_log.md b/doc/zh-Hans/guide_log.md new file mode 100644 index 0000000..ef16629 --- /dev/null +++ b/doc/zh-Hans/guide_log.md @@ -0,0 +1,6 @@ +# 日志 {#guide_log} + +日志系统用的 `glog` ,通用配置在头文件 `glog_init.h` 里。 + +* 日志文件会存储在当前工作目录, `make cleanlog` 可以清理。 +* 如果需要打开详细日志,请取消 `glog_init.h` 里注释的 `FLAGS_v = 2;` ,重新编译。 diff --git a/doc/zh-Hans/guide_opencv.md b/doc/zh-Hans/guide_opencv.md new file mode 100644 index 0000000..d6eacf2 --- /dev/null +++ b/doc/zh-Hans/guide_opencv.md @@ -0,0 +1,3 @@ +# OpenCV 依赖 {#guide_opencv} + +目前 SDK 本身未依赖 OpenCV ,仅是样例依赖其显示图像。 diff --git a/doc/zh-Hans/guide_samples.md b/doc/zh-Hans/guide_samples.md new file mode 100644 index 0000000..5f831eb --- /dev/null +++ b/doc/zh-Hans/guide_samples.md @@ -0,0 +1,27 @@ +# 样例 {#guide_samples} + +样例在 `/samples` 目录,其提供了不同接口层的使用范例。 + +* `api`, API 层接口,依赖 OpenCV 。 +* `device`,中间层接口,不依赖 OpenCV 。 +* `uvc`,底层接口。 + +> 目前 API 层接口,正在实现中。 + +## 依赖 + +* [OpenCV](https://opencv.org/),用于显示图像。 + +## 编译 + +```bash +make samples +``` + +## 运行 + +运行 `device` 层接口样例,显示图像并输出 IMU 。 + +```bash +./samples/_output/bin/device/camera_d +``` diff --git a/doc/zh-Hans/guides.md b/doc/zh-Hans/guides.md new file mode 100644 index 0000000..df21aad --- /dev/null +++ b/doc/zh-Hans/guides.md @@ -0,0 +1,6 @@ +# SDK 指导 {#guides} + +* @subpage guide_build_linux +* @subpage guide_samples +* @subpage guide_log +* @subpage guide_opencv