update docs

Author: sunxfancy

Readme.en.md

@@ -8,12 +8,12 @@ Hope you get 0 errors and 0 warnings everyday!
 ![](./docs/fig/zeroerr.jpg)
 
 
-
 ZeroErr is a smart assert library, a lightweight unit test framework and a quick logging framework. It integrates those features and provided an unite and clear interface for seperate using or joint using. 
 
-[Tutorial](./docs/tutorial.en.md)
+[English Documentation](https://sunxfancy.github.io/zeroerr/en/) | [项目文档](https://sunxfancy.github.io/zeroerr/zh/)
+
+Note: The project is currently in the experimental stage, and the API may change significantly. It is not recommended to use it in a production environment.
 
-[Introducation of Print Feature](./docs/print.en.md)
 
 ## Why we need another unit testing framework
 
@@ -138,6 +138,28 @@ TEST_CASE("match ostream") {
 Once you set `ZEROERR_HAVE_SAME_OUTPUT` marco, the system will check the output stream and save the first run result into a file. Then, the next run will compare the result to see if it the same. (Currently experimental)
 
 
+Finally, for the log system, the unit testing can access the log data to ensure that the function has executed the expected logic and results.
+
+```c++
+118 static void function() {
+119    LOG("function log {i}", 1);  
+120    LOG("function log {sum}, {i}", 10, 1);
+121 }
+...
+
+TEST_CASE("access log in Test case") {
+    zeroerr::suspendLog();
+    function();
+    CHECK(LOG_GET(function, 119, i, int) == 1);
+    CHECK(LOG_GET(function, 120, sum, int) == 10);
+    CHECK(LOG_GET(function, 120, i, int) == 1);
+    zeroerr::resumeLog();
+}
+```
+
+In order to access the log, we need to pause the log system first, to avoid the data being output to the file, then call the function, access the data in the log through the `LOG_GET` macro, and finally resume the log system. (Currently experimental, only the first call of each log point can be accessed)
+
+
 
 ## Features
 

Readme.md

@@ -12,6 +12,7 @@ ZeroErr 零误框架是一款轻量级C++单元测试框架，同时也集成了
 
 [项目文档](https://sunxfancy.github.io/zeroerr/zh/) | [English Documentation](https://sunxfancy.github.io/zeroerr/en/)
 
+注：目前项目处于实验阶段，API可能会有较大变动，不建议在生产环境中使用。
 
 ## 为何要开发一款新的测试框架
 
@@ -138,6 +139,28 @@ TEST_CASE("match ostream") {
 通过设置 `ZEROERR_HAVE_SAME_OUTPUT` 宏，系统会自动检查该测试点的output stream输出，第一次执行时的结果会自动保存起来，而之后每次执行，都会将输出与第一次输出进行对比，相同则正确，否则该点错误。用户可以第一次手动观察输出是否符合预期，若是修改了实现后，想清除保存的结果，只需要将测试目录下的 `output.txt` 缓存文件删除即可。(目前仍是实验功能)
 
 
+最后，对于日志系统，单元测试不但能够访问日志数据，以确保函数按照预期逻辑执行出来了结果。
+还可以在逻辑出错时，自动捕获函数中的断言和相关打印信息，以便于后续的调试。
+
+```c++
+118 static void function() {
+119    LOG("function log {i}", 1);  
+120    LOG("function log {sum}, {i}", 10, 1);
+121 }
+...
+
+TEST_CASE("access log in Test case") {
+    zeroerr::suspendLog();
+    function();
+    CHECK(LOG_GET(function, 119, i, int) == 1);
+    CHECK(LOG_GET(function, 120, sum, int) == 10);
+    CHECK(LOG_GET(function, 120, i, int) == 1);
+    zeroerr::resumeLog();
+}
+```
+
+为了访问log，我们首先要暂停log系统，避免数据被输出到文件中，然后调用函数，通过`LOG_GET`宏访问log中的数据，最后再恢复log系统的运行。(目前，暂时仅能获取到每个Log点第一次调用的数据，仍是实验功能)。
+
 
 ## 项目构建
 

docs/en/introduction.md

@@ -125,6 +125,30 @@ Once you set `ZEROERR_HAVE_SAME_OUTPUT` marco, the system will check the output
 
 
 
+Finally, for the log system, the unit testing can access the log data to ensure that the function has executed the expected logic and results.
+
+```c++
+118 static void function() {
+119    LOG("function log {i}", 1);  
+120    LOG("function log {sum}, {i}", 10, 1);
+121 }
+...
+
+TEST_CASE("access log in Test case") {
+    zeroerr::suspendLog();
+    function();
+    CHECK(LOG_GET(function, 119, i, int) == 1);
+    CHECK(LOG_GET(function, 120, sum, int) == 10);
+    CHECK(LOG_GET(function, 120, i, int) == 1);
+    zeroerr::resumeLog();
+}
+```
+
+In order to access the log, we need to pause the log system first, to avoid the data being output to the file, then call the function, access the data in the log through the `LOG_GET` macro, and finally resume the log system. (Currently experimental, only the first call of each log point can be accessed)
+
+
+
+
 ### Features
 
 

docs/zh/introduction.md

@@ -125,3 +125,25 @@ TEST_CASE("match ostream") {
 ```
 通过设置 `ZEROERR_HAVE_SAME_OUTPUT` 宏，系统会自动检查该测试点的output stream输出，第一次执行时的结果会自动保存起来，而之后每次执行，都会将输出与第一次输出进行对比，相同则正确，否则该点错误。用户可以第一次手动观察输出是否符合预期，若是修改了实现后，想清除保存的结果，只需要将测试目录下的 `output.txt` 缓存文件删除即可。(目前仍是实验功能)
 
+
+最后，对于日志系统，单元测试不但能够访问日志数据，以确保函数按照预期逻辑执行出来了结果。
+还可以在逻辑出错时，自动捕获函数中的断言和相关打印信息，以便于后续的调试。
+
+```c++
+118 static void function() {
+119    LOG("function log {i}", 1);  
+120    LOG("function log {sum}, {i}", 10, 1);
+121 }
+...
+
+TEST_CASE("access log in Test case") {
+    zeroerr::suspendLog();
+    function();
+    CHECK(LOG_GET(function, 119, i, int) == 1);
+    CHECK(LOG_GET(function, 120, sum, int) == 10);
+    CHECK(LOG_GET(function, 120, i, int) == 1);
+    zeroerr::resumeLog();
+}
+```
+
+为了访问log，我们首先要暂停log系统，避免数据被输出到文件中，然后调用函数，通过`LOG_GET`宏访问log中的数据，最后再恢复log系统的运行。(目前，暂时仅能获取到每个Log点第一次调用的数据，仍是实验功能)。