添加使用说明

2016-03-06 20:16:15 +08:00
parent 3fe018634d
commit f1f2cda255
1 changed files with 12 additions and 0 deletions
@@ -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文件名