chsrc/doc/README.md
2025-08-11 04:04:00 +08:00

38 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- -----------------------------------------------------------
! SPDX-License-Identifier: GFDL-1.3-or-later
! -------------------------------------------------------------
! Doc Type : Markdown
! Doc Name : (Document Introduction.md)
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-12-27>
! Last Modified : <2025-08-11>
! ---------------------------------------------------------- -->
# 文档说明
E2E (End-to-End) 开发文档:
1. 开发环境准备,如何编译和测试,请参考 [./01-Develop.md](./01-Develop.md)
2. 如何编写一个具体的 recipe请参考 [./10-Write-A-Recipe-Even-If-You-Dont-Know-C.md](./10-Write-A-Recipe-Even-If-You-Dont-Know-C.md)
3. 直接推送还是提交 PR请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
4. 代码风格,请参考 [./04-为什么拒绝使用代码格式化工具.md](./04-为什么拒绝使用代码格式化工具.md)
- 关于维护者身份的说明,请参考 [./10-MAINTAINERS.md](./10-MAINTAINERS.md)
<br>
用户手册:
1. [chsrc.1](./chsrc.1)
2. [chsrc.texi](./chsrc.texi)
<br>
## 贡献指导
若有任何问题,可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论
<br>