From f1f2cda255602b26ac17fbbc9eb81a7fbbfcc33e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=88=91=E6=89=8D=E6=98=AF=E4=BA=8C=E4=BA=AE?= Date: Sun, 6 Mar 2016 20:16:15 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E4=BD=BF=E7=94=A8=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2f597fd..c39607f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ # AutoBuildDocFromDB 使用SQL文件自动生成markdown格式的数据库文档。 + +## 使用说明 + +1. 使用git克隆该项目 + +2. 从数据库中导出sql文件,请尽量导出只有表结构无表数据的sql文件 + +3. 在项目目录下运行: +`python build.py sql_dir` +其中sql_dir为您的sql文件路径 + +4. 生成成功的md文件,在项目的md文件夹中,文件名同您的sql文件名 \ No newline at end of file