Skip to content

Commit 9507dac

Browse files
committed
update documentation
1 parent 14f6105 commit 9507dac

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

Contributing.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,13 @@
88
4. 所有文档、教程的修改请务必注意保持中英版本一致
99
5. 代码中注释的添加与修改请确保使用英文,避免出现编译器编码问题
1010
6. 确保修改后完整构建过一次本项目,这样可以使得根目录下的合并版`zeroerr.hpp`文件与源码保持一致
11-
7. 我们欢迎给特殊环境的使用、第三方库的集成提供扩展功能,请将这些扩展放到extension目录下
11+
7. 我们欢迎给特殊环境的使用、第三方库的集成提供扩展功能,请将这些扩展放到extension目录下
12+
13+
14+
## 小技巧
15+
16+
### 启用 git pre-commit hook
17+
这个hook会在每次commit前运行,可以用来检查代码风格、运行测试等,最后把构建的zeroerr.hpp文件放到根目录下并一起提交
18+
```bash
19+
git config --local core.hooksPath .githooks/
20+
```

docs/en/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ features:
1313
- title: Header-only
1414
details: Header-only library, easy to use and integrate with your project. Support C++11/14/17/20.
1515
- title: Small and Fast
16-
details: Only 3K+ lines of C++ code, fast to compile and run.
16+
details: Only 5K+ lines of C++ code, fast to compile and run.
1717
- title: Multi-Scene Usage
1818
details: Configure the print rules once, and it can be applied to multiple scenes such as logging, unit testing, and debugging at the same time.
1919
footer: MIT Licensed | Copyright © 2022-present 西风逍遥游

docs/zh/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ features:
1313
- title: 单文件,易引入
1414
details: Header-only的库,只需引入一个头文件即可使用。
1515
- title: 小巧快速
16-
details: 仅3K余行C++代码,编译速度快,运行速度快。
16+
details: 仅5K行C++代码,编译速度快,运行速度快。
1717
- title: 多场景使用
1818
details: 一次配置打印规则,可同时应用于日志,单元测试,调试等场景。
1919
footer: MIT Licensed | Copyright © 2022-present 西风逍遥游

0 commit comments

Comments
 (0)