diff --git a/README.md b/README.md index 69d85d4..08bf090 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -project/ -├── src/ -│ └── __init__.py -├── tests/ # ✅ 测试目录(pytest 自动发现) -│ └── test_example.py -├── .python-version # ✅ 本地虚拟python环境(uv venv 创建) -├── main.py # ✅ 主程序 -├── pyproject.toml # ✅ 全局配置 -├── README.md # ✅ 项目说明(包含安装、使用、发布) -└── uv.lock # ✅ uv 快照(可选) +# 项目目录结构说明 + +## 核心结构概览 +```plaintext +project/ # 项目根目录 +├── src/ # ✅ 源代码包 +│ └── __init__.py # 包标识文件(可定义公共API)[9,10](@ref) +├── tests/ # ✅ 测试目录(pytest自动发现用例) +│ └── test_example.py # 测试示例(需以`test_`前缀命名)[2,9](@ref) +├── .python-version # ✅ 指定Python版本(如3.11.4) +├── main.py # ✅ 主程序入口(CLI执行入口) +├── pyproject.toml # ✅ 全局配置(依赖/元数据/构建设置)[10](@ref) +├── README.md # ✅ 项目说明(必含安装/使用/发布指南)[6,7](@ref) +└── uv.lock # ✅ UV依赖快照(锁定版本号,可选但推荐)[8](@ref) \ No newline at end of file