refactor: restructure project to modern Python layout, separate src, tests, docs, examples
This commit is contained in:
50
docs/README.md
Normal file
50
docs/README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Config-Man 文档
|
||||
|
||||
本目录包含 Config-Man 项目的所有文档。
|
||||
|
||||
## 文档结构
|
||||
|
||||
- `README.md` - 项目主文档
|
||||
- `USAGE.md` - 使用说明文档
|
||||
- `progress-tracker.md` - 进度跟踪文档
|
||||
- `requirements.md` - 需求文档
|
||||
- `workplan.md` - 工作计划文档
|
||||
|
||||
## 快速开始
|
||||
|
||||
1. 安装项目:
|
||||
```bash
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
2. 查看帮助:
|
||||
```bash
|
||||
python main.py --help
|
||||
```
|
||||
|
||||
3. 使用查看功能:
|
||||
```bash
|
||||
python main.py view --version 0.30 --mock
|
||||
```
|
||||
|
||||
## 开发指南
|
||||
|
||||
1. 安装开发依赖:
|
||||
```bash
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
2. 运行测试:
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
3. 代码格式化:
|
||||
```bash
|
||||
black src/ tests/
|
||||
```
|
||||
|
||||
4. 类型检查:
|
||||
```bash
|
||||
mypy src/
|
||||
```
|
||||
Reference in New Issue
Block a user