Initial commit: 创建工具箱项目
This commit is contained in:
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# 🧰 工具箱 (Tools)
|
||||||
|
|
||||||
|
存放各种小工具、脚本和代码片段的仓库。
|
||||||
|
|
||||||
|
## 📁 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
tools/
|
||||||
|
├── scripts/ # 可执行脚本(Python、Shell 等)
|
||||||
|
├── utils/ # 工具类/函数库
|
||||||
|
├── snippets/ # 代码片段
|
||||||
|
└── README.md # 本文件
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 使用说明
|
||||||
|
|
||||||
|
- **scripts/**: 存放独立的可执行脚本,每个脚本应有清晰的注释说明用途
|
||||||
|
- **utils/**: 存放可复用的工具函数或类库
|
||||||
|
- **snippets/**: 存放常用代码片段,按语言或功能分类
|
||||||
|
|
||||||
|
## 📝 新增工具规范
|
||||||
|
|
||||||
|
1. 每个脚本/工具文件头部添加注释说明用途、用法
|
||||||
|
2. 复杂脚本附带简单的使用示例
|
||||||
|
3. 如有依赖,注明依赖项
|
||||||
|
|
||||||
|
## 📦 已收录工具
|
||||||
|
|
||||||
|
| 名称 | 路径 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| - | - | 待添加 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
* created by 湖边的小龙虾 🦞
|
||||||
Reference in New Issue
Block a user