tools

wangdefa/tools

Fork 0

Commit Graph

Author	SHA1	Message	Date
Wang Defa	71d487c59a	docs: 从 README 中移除 llmdoc 相关内容 ## 修改原因 llmdoc/ 目录已在 .gitignore 中被忽略，不应在 README 中引用。 ## 变更内容 ### 移除的章节 1. 项目结构：移除 llmdoc/ 目录及其子目录说明 2. 📖 文档：移除整个文档章节（包含 7 个 llmdoc 链接） 3. 编码规范：移除指向 llmdoc/reference/coding-conventions.md 的链接 ### 保留的内容 - ✅ 公共库文档链接（common/README.md） - ✅ 远程加载文档链接（examples/REMOTE_LOADER_README.md） - ✅ 所有其他功能和使用说明 ## 影响 - 文档更加简洁，只包含版本控制中的内容 - 用户可通过 common/ 和 examples/ 目录中的文档获取详细信息 - 与 .gitignore 配置保持一致	2025-12-26 15:04:57 +08:00
Wang Defa	f6d9274306	docs: 添加项目主 README 文档 ## 新增内容添加项目根目录 README.md，提供完整的项目介绍和使用指南。 ## 文档内容 ### 核心章节 1. 项目简介: 概述项目目标和核心特性 2. 项目结构: 清晰的目录树和模块说明 3. 快速开始: 三种使用模式的快速指南 4. 功能模块: 详细的工具功能和使用示例 5. 远程库加载: 智能加载机制说明 6. 公共库: logging.sh 和 error_handler.sh 使用方法 7. 文档导航: llmdoc 文档系统链接 8. 开发指南: 编码规范和贡献流程 ### 特色内容 - ✅ Shields.io 徽章（版本、Shell、许可证） - ✅ Emoji 图标增强可读性 - ✅ 代码示例和命令行演示 - ✅ 环境变量配置表格 - ✅ 完整的使用场景覆盖 - ✅ 内部文档交叉引用 - ✅ 版本更新日志 ### 使用场景 - 📖 新用户快速了解项目 - 🚀 快速开始使用工具 - 📚 查找功能和使用方法 - 🔗 导航到详细文档	2025-12-26 15:02:30 +08:00

Author

SHA1

Message

Date

Wang Defa

71d487c59a

docs: 从 README 中移除 llmdoc 相关内容

## 修改原因

llmdoc/ 目录已在 .gitignore 中被忽略，不应在 README 中引用。

## 变更内容

### 移除的章节

1. **项目结构**：移除 llmdoc/ 目录及其子目录说明
2. **📖 文档**：移除整个文档章节（包含 7 个 llmdoc 链接）
3. **编码规范**：移除指向 llmdoc/reference/coding-conventions.md 的链接

### 保留的内容

- ✅ 公共库文档链接（common/README.md）
- ✅ 远程加载文档链接（examples/REMOTE_LOADER_README.md）
- ✅ 所有其他功能和使用说明

## 影响

- 文档更加简洁，只包含版本控制中的内容
- 用户可通过 common/ 和 examples/ 目录中的文档获取详细信息
- 与 .gitignore 配置保持一致

2025-12-26 15:04:57 +08:00

Wang Defa

f6d9274306

docs: 添加项目主 README 文档

## 新增内容

添加项目根目录 README.md，提供完整的项目介绍和使用指南。

## 文档内容

### 核心章节

1. **项目简介**: 概述项目目标和核心特性
2. **项目结构**: 清晰的目录树和模块说明
3. **快速开始**: 三种使用模式的快速指南
4. **功能模块**: 详细的工具功能和使用示例
5. **远程库加载**: 智能加载机制说明
6. **公共库**: logging.sh 和 error_handler.sh 使用方法
7. **文档导航**: llmdoc 文档系统链接
8. **开发指南**: 编码规范和贡献流程

### 特色内容

- ✅ Shields.io 徽章（版本、Shell、许可证）
- ✅ Emoji 图标增强可读性
- ✅ 代码示例和命令行演示
- ✅ 环境变量配置表格
- ✅ 完整的使用场景覆盖
- ✅ 内部文档交叉引用
- ✅ 版本更新日志

### 使用场景

- 📖 新用户快速了解项目
- 🚀 快速开始使用工具
- 📚 查找功能和使用方法
- 🔗 导航到详细文档

2025-12-26 15:02:30 +08:00

2 Commits