From 2dc470e14f0c8f76eb02ffef8ea5c0bec184552d Mon Sep 17 00:00:00 2001
From: John Zhao <johnzhao@slightech.com>
Date: Wed, 25 Apr 2018 12:28:06 +0800
Subject: [PATCH] Update samples, tools readme and guide doc

---
 doc/zh-Hans/guide_samples.md | 18 ++++++++++++++----
 doc/zh-Hans/guide_tools.md   | 32 +++++++++++++++++++++++++++-----
 samples/README.md            | 15 +++++++++++++++
 tools/README.md              | 30 +++++++++++++++++++++++++++---
 4 files changed, 83 insertions(+), 12 deletions(-)

diff --git a/doc/zh-Hans/guide_samples.md b/doc/zh-Hans/guide_samples.md
index ba4653e..5c340f6 100644
--- a/doc/zh-Hans/guide_samples.md
+++ b/doc/zh-Hans/guide_samples.md
@@ -11,12 +11,15 @@
 ## 依赖
 
 * [OpenCV](https://opencv.org/)，用于显示图像。
+  * 编译前，可在系统终端（Windows 命令提示符）里如下指定 OpenCV 路径，其为 `OpenCVConfig.cmake` 目录：
 
-<!--
-```cmd
->set OpenCV_DIR=C:\opencv
+```bash
+# Linux, macOS
+export OpenCV_DIR=~/opencv
+
+# Windows
+set OpenCV_DIR=C:\opencv
 ```
--->
 
 ## 编译
 
@@ -30,4 +33,11 @@ make samples
 
 ```bash
 ./samples/_output/bin/device/camera_d
+
+# Windows
+.\samples\_output\bin\device\camera_d.bat
 ```
+
+## 结语
+
+更多样例的说明，请见 `samples/README.md` 。
diff --git a/doc/zh-Hans/guide_tools.md b/doc/zh-Hans/guide_tools.md
index ad228b2..c483b50 100644
--- a/doc/zh-Hans/guide_tools.md
+++ b/doc/zh-Hans/guide_tools.md
@@ -2,19 +2,39 @@
 
 样例在 `<sdk>/tools` 目录，其提供一些有用的工具。
 
-## 准备
+## 依赖
+
+* [OpenCV](https://opencv.org/)，部分工具需要。
+  * 编译前，可在系统终端（Windows 命令提示符）里如下指定 OpenCV 路径，其为 `OpenCVConfig.cmake` 目录：
+
+```bash
+# Linux, macOS
+export OpenCV_DIR=~/opencv
+
+# Windows
+set OpenCV_DIR=C:\opencv
+```
+
+* Python 第三方库，脚本需要。
+
+```bash
+cd tools/
+sudo pip install -r requirements.txt
+```
+
+## 编译
 
 ```bash
 make tools
-
-cd tools/
-sudo pip install -r requirements.txt
 ```
 
 ## 录制数据集
 
 ```bash
 ./tools/_output/bin/dataset/record
+
+# Windows
+.\tools\_output\bin\dataset\record.bat
 ```
 
 默认录制进 `dataset` 目录，加参数可指定该目录。
@@ -46,6 +66,8 @@ python tools/analytics/stamp_analytics.py -i dataset -c tools/config/mynteye/myn
 \includegraphics[width=0.6\textwidth,keepaspectratio]{stamp_analytics.png}
 \endlatexonly
 
+> 如果用 ROS ，分析脚本也支持 ROS Bag 格式。
+
 ## 结语
 
-如果用 ROS ，分析脚本也支持 ROS Bag 格式。关于 ROS 的录制和分析，请见 `tools/README.md` 。
+设备信息读写、校验码等更多工具的说明，请见 `tools/README.md` 。
diff --git a/samples/README.md b/samples/README.md
index 11b2903..e4747b6 100644
--- a/samples/README.md
+++ b/samples/README.md
@@ -1,5 +1,17 @@
 # Samples for MYNT® EYE cameras
 
+## Prerequisites
+
+[OpenCV](https://opencv.org/),
+
+```bash
+# Linux, macOS
+export OpenCV_DIR=~/opencv
+
+# Windows
+set OpenCV_DIR=C:\opencv
+```
+
 ## Build
 
 ```bash
@@ -11,4 +23,7 @@ make samples
 
 ```bash
 ./samples/_output/bin/device/camera_d
+
+# Windows
+.\samples\_output\bin\device\camera_d.bat
 ```
diff --git a/tools/README.md b/tools/README.md
index 0e70c01..54d6c7c 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -2,6 +2,16 @@
 
 ## Prerequisites
 
+[OpenCV](https://opencv.org/),
+
+```bash
+# Linux, macOS
+export OpenCV_DIR=~/opencv
+
+# Windows
+set OpenCV_DIR=C:\opencv
+```
+
 Python packages,
 
 ```bash
@@ -11,17 +21,22 @@ sudo pip install -r requirements.txt
 
 [ROS](http://www.ros.org/) if using rosbag.
 
----
-
-## Record data (mynteye dataset)
+## Build
 
 ```bash
 cd <sdk>
 make tools
 ```
 
+---
+
+## Record data (mynteye dataset)
+
 ```bash
 ./tools/_output/bin/dataset/record
+
+# Windows
+.\tools\_output\bin\dataset\record.bat
 ```
 
 ## Analytics data (mynteye dataset)
@@ -79,18 +94,27 @@ python tools/analytics/stamp_analytics.py -i mynteye.bag
 
 ```bash
 ./tools/_output/bin/writer/device_info_writer tools/writer/config/device.info
+
+# Windows
+.\tools\_output\bin\writer\device_info_writer.bat tools\writer\config\device.info
 ```
 
 ### img_params_writer.cc
 
 ```bash
 ./tools/_output/bin/writer/img_params_writer tools/writer/config/img.params
+
+# Windows
+.\tools\_output\bin\writer\img_params_writer.bat tools\writer\config\img.params
 ```
 
 ### imu_params_writer.cc
 
 ```bash
 ./tools/_output/bin/writer/imu_params_writer tools/writer/config/imu.params
+
+# Windows
+.\tools\_output\bin\writer\imu_params_writer.bat tools\writer\config\imu.params
 ```
 
 ---