add doc

README.md

@@ -8,6 +8,10 @@
 
 目前 github 和 sourceforge 上的本版比 gitee 上的版本都低，建议在 gitee 上下载最新版本。
 
+## 文档
+
+请参考 [comNG 完整文档](doc/Introduction.md)
+
 ## 介绍
 
 comNG 区别于其他串口助手的地方在于其强大的 “现场数据分析“ 能力。简单来说就是 comNG 提供的多种功能以帮助用户更方便的分析打印输出文本。这些功能包括：

doc/Highlight-in-comNG.md

@@ -0,0 +1,20 @@
+# `comNG` 里的高亮
+
+高亮是 `comNG` 最原始的需求、最重要的功能，也是花费精力最多的地方。
+
+常规的串口日志分析流程是直接发送的串口工具上的，但是只要日志稍微复杂一些，就需要考到其他的文本编辑器里做进一步分析，比如我就经常会考到 notepad++ 里。 在 notepad++ 里，我们可以搜索标记文本、高亮特定文本等等。其实这些功能不算复杂，但是大部分现有的串口工具是没有类似功能的。
+
+于是就有了 `comNG`，而且把高亮推向了更极端的方向。在 `comNG` 里高亮类型有：
+
+- 基于 `comNGLang` 语法的高亮
+- 基于 monaco editor 内置的搜索和鼠标点选高亮
+- 单独实现的手动文本高亮
+- Hex Mode 里鼠标位置的对比高亮
+- Hex Mode 里选择文本的对比高亮
+
+由于自我感觉 Hex Mode 的高亮实在是太有吸引力（似乎其他标准的 Hex 编辑器没有类似的高亮功能），最新版的 `comNG` 添加了以 Hex 模式打开文件的功能。这样就可以使用 `comNG` 的 Hex Mode 高亮功能对文件进行简单的十六进制分析了。
+
+这里是一些参考图片：
+
+![image](../image/highlighter.jpg)
+![image](../image/hex-mode.png)

doc/Introduction.md

@@ -1,8 +1,17 @@
 # `comNG` 使用说明
 
-`cmNG` 是一款现代且功能强大的串口助手软件。基础的介绍和使用说明已经在 readme 提及了，这里主要阐述 `comNG` 使用过程中稍微复杂的部分，包括：
+`comNG` 是一款现代且功能强大的串口助手软件。基础的介绍和使用说明已经在 readme 提及了，这里主要阐述 `comNG` 使用过程中稍微复杂的部分，包括：
 
 - [`comNGLang` 语法说明](./comNGLang-Syntax.md)
-- [`comNG` 里的各种高亮](./Highlights-in-comNG.md)
+- [`comNG` 里的高亮](./Highlights-in-comNG.md)
 - [`comNG` 里的快捷键](./Shortcuts-in-comNG.md)
 - [`comNG` 里的其他高级功能](./Other-Advances-in-comNG.md)
+
+`comNG` 使用的主要组件包括：
+
+- [Electron](https://www.electronjs.org/)
+- [Node SerialPort](https://serialport.io/)
+- [monaco editor](https://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html)
+- [Materialize](https://materializecss.com/)
+
+没有这些强大的模块，`comNG` 是做不出来，非常感谢相关作者和贡献者。

doc/Other-Advances-in-comNG.md

@@ -0,0 +1,41 @@
+# `comNG` 里其他的高级功能
+
+这里的**高级功能**其实只是一些其他串口助手里没有的或者稍微特殊些的功能，归纳在这里，方便大家查询。
+
+## Modem 信号显示和控制
+
+在 General 标签页内使能 Modem Signal 功能即可，如下图：
+![image](../image/modem-signal.png)
+其中 CTS、DSR 和 DCD 信号是只读的，每 100 ms 刷新一次；RTS 和 DTR 是可控的。
+
+## 自定义波特率
+
+`comNG` 支持自定义一个波特率：首先在 General 页面的 Customized Baud Rate 输入框里输入需要自定义的波特率，然后在操作面板里选择之前设置的波特率即可。这里自定义的波特率是自动记录的，下次启动 App 时这个波特率还是之前自定义的值。
+
+## 模拟的发送终端模式
+
+在发送页面里，如果 EOF 选项选择了 TERM 模式，则开启模拟 Terminal 模式。这种模式下，换行符是 LF，发送的文本在点击 Enter 键后会发送出去并自动清空。 有些时候这个模式还是挺方便的。
+
+## 签名功能
+
+这个功能在 Advance 页面打开，你还可以配置上你的姓名。该功能开启后，在你点击清空所有日志后，App 会主动在新的日志文件的第一行输入该日志生成的时间和生成人员的名称（如果配置了姓名）。效果如下图：
+![image](../image/sign.png)
+
+## 断点功能
+
+这是一个实用性比较强的功能，在 Advance 页面开启。你需要给该功能配置断点文本和断点行数，具体逻辑是：
+
+1. 本次接收到的串口数据里是否包含断点文本
+2. 如果包含断点文本，则开始记录收到的换行符
+3. 如果收到的换行符等于断点行数，则自动关闭串口，保留该断点文本的上下文。
+
+如果你需要在快速刷新的日志里捕获特定文本，那么这个功能可以给你很多帮助。
+
+## 自定义操作面板颜色
+
+颜值是一个避不开的话题，`comNG` 的所有 UI 设计都是经过像素级考量的。当时在设计 UI 时，其他地方都很满意，唯独操作面板这块找不到感觉。于是这块变成了可配置的。比如下面几种配置，感觉闭着眼都能配出来好颜色：）
+
+![image](../image/bar-color-1.jpg)
+![image](../image/bar-color-2.jpg)
+
+OK，差不多这些，希望大家喜欢。