93d1b21的任务收尾
This commit is contained in:
@@ -0,0 +1,97 @@
|
||||
<!--
|
||||
模板:application(应用程序)
|
||||
适用:CLI 工具、GUI 应用、Web 应用、后端服务
|
||||
特点:安装部署清晰、功能完整、配置详细
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 功能特性
|
||||
|
||||
{{FEATURES}}
|
||||
|
||||
## 截图/演示
|
||||
|
||||
{{SCREENSHOTS}}
|
||||
|
||||
## 系统要求
|
||||
|
||||
{{REQUIREMENTS}}
|
||||
|
||||
## 安装
|
||||
|
||||
### 方式一:预编译版本
|
||||
|
||||
{{INSTALL_BINARY}}
|
||||
|
||||
### 方式二:从源码构建
|
||||
|
||||
{{INSTALL_SOURCE}}
|
||||
|
||||
## 快速开始
|
||||
|
||||
{{QUICKSTART}}
|
||||
|
||||
## 使用说明
|
||||
|
||||
### 基本命令
|
||||
|
||||
{{BASIC_COMMANDS}}
|
||||
|
||||
### 常用操作
|
||||
|
||||
{{COMMON_OPERATIONS}}
|
||||
|
||||
## 配置
|
||||
|
||||
### 配置文件位置
|
||||
|
||||
{{CONFIG_LOCATION}}
|
||||
|
||||
### 配置项说明
|
||||
|
||||
{{CONFIG_OPTIONS}}
|
||||
|
||||
### 配置示例
|
||||
|
||||
```
|
||||
{{CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
## 开发
|
||||
|
||||
### 环境搭建
|
||||
|
||||
{{DEV_SETUP}}
|
||||
|
||||
### 构建
|
||||
|
||||
{{BUILD}}
|
||||
|
||||
### 测试
|
||||
|
||||
{{TEST}}
|
||||
|
||||
## 常见问题
|
||||
|
||||
{{FAQ}}
|
||||
|
||||
## 更新日志
|
||||
|
||||
查看 [CHANGELOG.md](CHANGELOG.md) 了解版本历史。
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎贡献!请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
## 致谢
|
||||
|
||||
{{ACKNOWLEDGEMENTS}}
|
||||
@@ -0,0 +1,64 @@
|
||||
<!--
|
||||
模板:documentation(纯文档)
|
||||
适用:教程、指南、规范文档、知识库、材料集
|
||||
特点:结构清晰、导航便捷、内容为主
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 目录
|
||||
|
||||
{{TOC}}
|
||||
|
||||
## 概述
|
||||
|
||||
{{OVERVIEW}}
|
||||
|
||||
## 目标读者
|
||||
|
||||
{{AUDIENCE}}
|
||||
|
||||
## 如何阅读
|
||||
|
||||
{{READING_GUIDE}}
|
||||
|
||||
## 文档结构
|
||||
|
||||
```
|
||||
{{STRUCTURE}}
|
||||
```
|
||||
|
||||
## 快速导航
|
||||
|
||||
| 主题 | 文档 | 说明 |
|
||||
|------|------|------|
|
||||
{{NAV_TABLE}}
|
||||
|
||||
## 入门指南
|
||||
|
||||
{{GETTING_STARTED}}
|
||||
|
||||
## 核心概念
|
||||
|
||||
{{CORE_CONCEPTS}}
|
||||
|
||||
## 参考资料
|
||||
|
||||
{{REFERENCES}}
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎改进文档!
|
||||
|
||||
- 发现错误:提交 Issue
|
||||
- 内容建议:提交 PR
|
||||
|
||||
## 版本历史
|
||||
|
||||
{{VERSION_HISTORY}}
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
@@ -0,0 +1,69 @@
|
||||
<!--
|
||||
模板:library(库/工具)
|
||||
适用:npm/cargo/pip/gem 等包管理器发布的库、SDK、工具包
|
||||
特点:安装优先、API 清晰、示例丰富
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 功能特性
|
||||
|
||||
{{FEATURES}}
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
{{INSTALLATION}}
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
|
||||
```
|
||||
{{QUICKSTART_CODE}}
|
||||
```
|
||||
|
||||
## API 文档
|
||||
|
||||
{{API_DOCS}}
|
||||
|
||||
### 核心方法
|
||||
|
||||
{{CORE_METHODS}}
|
||||
|
||||
### 配置选项
|
||||
|
||||
{{OPTIONS}}
|
||||
|
||||
## 示例
|
||||
|
||||
### 基础用法
|
||||
|
||||
```
|
||||
{{EXAMPLE_BASIC}}
|
||||
```
|
||||
|
||||
### 进阶用法
|
||||
|
||||
```
|
||||
{{EXAMPLE_ADVANCED}}
|
||||
```
|
||||
|
||||
## 兼容性
|
||||
|
||||
{{COMPATIBILITY}}
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎贡献代码!请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
## 作者
|
||||
|
||||
{{AUTHOR}}
|
||||
@@ -0,0 +1,36 @@
|
||||
<!--
|
||||
模板:minimal(微型项目)
|
||||
适用:< 500 行代码的小工具、脚本、单文件项目
|
||||
特点:精简、聚焦核心功能、快速理解
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 用法
|
||||
|
||||
```bash
|
||||
{{USAGE}}
|
||||
```
|
||||
|
||||
## 示例
|
||||
|
||||
```
|
||||
{{EXAMPLES}}
|
||||
```
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
{{INSTALLATION}}
|
||||
```
|
||||
|
||||
<!-- 可选:如有配置项 -->
|
||||
## 配置
|
||||
|
||||
{{CONFIGURATION}}
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
@@ -0,0 +1,101 @@
|
||||
<!--
|
||||
模板:monorepo(多项目仓库)
|
||||
适用:包含多个子项目的仓库、工作区项目
|
||||
特点:子项目索引、统一说明、各项目独立介绍
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
{{STRUCTURE}}
|
||||
```
|
||||
|
||||
## 子项目
|
||||
|
||||
| 项目 | 路径 | 说明 | 状态 |
|
||||
|------|------|------|------|
|
||||
{{SUBPROJECTS_TABLE}}
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
{{REQUIREMENTS}}
|
||||
|
||||
### 克隆仓库
|
||||
|
||||
```bash
|
||||
{{CLONE_COMMAND}}
|
||||
```
|
||||
|
||||
### 初始化
|
||||
|
||||
```bash
|
||||
{{INIT_COMMAND}}
|
||||
```
|
||||
|
||||
## 各子项目介绍
|
||||
|
||||
### {{SUBPROJECT_1_NAME}}
|
||||
|
||||
{{SUBPROJECT_1_DESCRIPTION}}
|
||||
|
||||
**快速开始**:
|
||||
|
||||
```bash
|
||||
{{SUBPROJECT_1_QUICKSTART}}
|
||||
```
|
||||
|
||||
[详细文档]({{SUBPROJECT_1_README}})
|
||||
|
||||
### {{SUBPROJECT_2_NAME}}
|
||||
|
||||
{{SUBPROJECT_2_DESCRIPTION}}
|
||||
|
||||
**快速开始**:
|
||||
|
||||
```bash
|
||||
{{SUBPROJECT_2_QUICKSTART}}
|
||||
```
|
||||
|
||||
[详细文档]({{SUBPROJECT_2_README}})
|
||||
|
||||
<!-- 根据实际子项目数量添加更多 -->
|
||||
|
||||
## 开发指南
|
||||
|
||||
### 依赖管理
|
||||
|
||||
{{DEPENDENCY_MANAGEMENT}}
|
||||
|
||||
### 构建所有项目
|
||||
|
||||
```bash
|
||||
{{BUILD_ALL}}
|
||||
```
|
||||
|
||||
### 测试所有项目
|
||||
|
||||
```bash
|
||||
{{TEST_ALL}}
|
||||
```
|
||||
|
||||
### 发布流程
|
||||
|
||||
{{RELEASE_PROCESS}}
|
||||
|
||||
## 贡献
|
||||
|
||||
请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
各子项目可能有独立的许可证,详见各项目目录。
|
||||
Reference in New Issue
Block a user