From 5cce06219ab0d49719711a7252c60e3d5c712f4a Mon Sep 17 00:00:00 2001
From: zhanglei <rayzhangmail@163.com>
Date: Fri, 30 Jan 2026 16:57:03 +0800
Subject: [PATCH] init

---
 README.md        | 86 ++++++++++++++++++++++++++++++++++++++++++++++++
 requirements.txt |  3 ++
 2 files changed, 89 insertions(+)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index 118308c..7626ff6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,88 @@
 # codegen
 
+## 项目描述：   
+### 脚手架生成器,可以根据数据库的表生成可执行的完整项目.
+###     基础组件 : java8(jdk corretto-1.8) + maven(3.8.0) + springboot + mybatis + mybatisplus
+###     可选组件 : xxlJob + swagger + redis + mysql + minio + satoken
+###     例如生成项目目录结构:
+~~java
+    src
+    ├── main
+    │   ├── java
+    │   │   └── com
+    │   │       └── test
+    │   │           └── api
+    │   │               ├── models
+    │   │               │   ├── common
+    │   │               │   └── config
+    │   │               │       ├── MybatisPlusConfig.java
+    │   │               │       ├── WebLogAspect.java
+    │   │               │       └── unit
+    │   │               │           ├── FilesUtil.java
+    │   │               │           ├── Md5HashUtil.java
+    │   │               │           └── vo
+    │   │               │               └── Result.java
+    │   │               ├── controller
+    │   │               │   └── HealthFunController.java
+    │   │               ├── entity
+    │   │               │   ├── BaseEntity.java
+    │   │               │   └── HealthFun.java
+    │   │               ├── mapper
+    │   │               │   └── HealthFunMapper.java
+    │   │               ├── service
+    │   │               │   ├── impl
+    │   │               │   │   └── HealthFunMPJBaseServiceImpl.java
+    │   │               │   └── HealthFunService.java
+    │   │               └── Application.java
+    │   └── resources
+    │       ├── mappers
+    │       │   └── HealthFunMapper.xml
+    │       ├── application.yml
+    │       ├── application-dev.yml
+    │       └── logback.xml
+    ├── test
+    │   └── java
+    │       └── com
+    │           └── test
+    │               └── api
+    │                   └── ApplicationTests.java
+    └── pom.xml
+~~
+
+## 运行生成项目目录结构:
+
+~~java
+    codegen/
+    ├── generator.py 主函数
+    ├── config.yml  项目配置文件
+    ├── templates/ 模板文件
+    │   ├── entity.java.j2
+    │   ├── controller.java.j2
+    │   └── ...
+    ├── utils.py   公共 方法
+    ├── db.py 数据库操作
+    └── requirements.txt 依赖包
+~~
+
+## 已知可运行环境 Python 3.13.5
+### 打包
+###     Windows 运行命令:
+###     python.exe -m pip install pyinstaller
+###     python.exe -m PyInstaller --onefile --name generator generator.py
+###     Mac/Linux 运行命令:
+###     python3 -m pip install pyinstaller
+###     python3 -m PyInstaller --onefile --name generator generator.py
+
+## 执行
+
+~~java
+    generator.exe -h
+    
+    options:
+    -h, --help     show this help message and exit
+    --tab TAB      表名，多个用逗号分隔，例如: tab,tab2
+    --model MODEL  可选模块 xxlJob,minio,saToken,swagger
+    --re           是否覆盖已存在文件（默认不覆盖）
+    --conf CONF    配置文件路径
+~~
+
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..7622617
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+jinja2
+pymysql
+pyyaml
\ No newline at end of file