Skip to content

Commit 395f91a

Browse files
committed
更新文档
1. 更新README.md与README_CN.md 2. 添加图片文件
1 parent 8046afc commit 395f91a

File tree

5 files changed

+29
-2
lines changed

5 files changed

+29
-2
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,20 @@ When receiving signals: SIGINT, SIGTERM, SIGQUIT, SIGPWR, it will execute the ex
7676
When various program exceptions occur in the program, such as: segment fault, assertion, bus error, exception not caught, etc., the framework will capture and print the complete call stack in the log system. Facing program crashes, no longer look blank. The effect is as follows:
7777
![stack print](documents/images/0006-error-dump.png)
7878

79-
## 9. Rich components
79+
## 9. Visualized trace module
80+
The trace module can record the time and duration of each execution of the marked function, and can export the flame graph for display:
81+
![trace fire graph](documents/images/0011-trace-view.png)
82+
It is a great tool for performance analysis and event blocking problem troubleshooting.
83+
84+
## 10. Simple and visualized state machine
85+
It abandons the cumbersome inheritance and derivation of the traditional state mode, and uses it directly in a combined way, which is simple and convenient. It can also export the state machine diagram to achieve what you see is what you get:
86+
![visualized state machine](documents/images/0010-state-machine-graph.png)
87+
88+
## 11. Visualized behavior tree
89+
It contains an event-driven behavior tree that can realize sequential, branching, and cyclic action processes in an asynchronous environment, and can export a visual tree diagram in real time:
90+
![visualized behavior tree](documents/images/0010-action-tree-graph.jpg)
91+
92+
## 12. Rich components
8093

8194
| Name | What |
8295
|:----:|:----|

README_CN.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,21 @@
7676
当程序出现各种程序异常,如:段错误、断言、总线错误、异常未捕获等,架框会捕获并在日志系统中打印完整的调用栈。面对程序崩溃,不再一脸茫然。效果如下:
7777
![异常栈打印](documents/images/0006-error-dump.png)
7878

79-
## 9. 有丰富的开发组件
79+
## 9. 有可视化的运行跟踪模块
80+
trace模块能记录被标记的函数每次执行的时间点与时长,可导出火焰图进行展示:
81+
![trace火焰图](documents/images/0011-trace-view.png)
82+
它是性能分析、事件阻塞问题排查了一大利器。
83+
84+
## 10. 有简单易用的状态机
85+
摒弃了传统状态模式繁琐的继承与派生,以组合的方式直接使用,简单便捷,还能导出状态机图,实现所见即所得:
86+
![可视化状态机](documents/images/0010-state-machine-graph.png)
87+
88+
89+
## 11. 有可视化的行为树
90+
内含基于事件驱动的行为树,能在异步环境实现顺序、分支、循环的动作流程,并能实时导出可视化树形图。动作流程、运行的状态一目了然:
91+
![可视化行为树](documents/images/0010-action-tree-graph.jpg)
92+
93+
## 12. 有丰富的开发组件
8094

8195
| 库名 | 中文名 | 说明 |
8296
|:----:|:---:|:----|
178 KB
Loading
57.6 KB
Loading

documents/images/0011-trace-view.png

64.5 KB
Loading

0 commit comments

Comments
 (0)