diff --git a/README.MD b/README.MD index 242b16777baf3cd27b489ba52b6ba473151df3e2..119ca08dbc6a85f95bf88e4de5982d13647dcabf 100644 --- a/README.MD +++ b/README.MD @@ -1,188 +1,63 @@ -
- EasyDataBaseExport - -

- EasyDataBaseExport -

- -
-

- IntelliJ IDEA 2023 - java - JDK Version - release - license -

-## 简介 +由于提供的代码地图中没有具体的代码结构信息，以下是一个基于常见项目结构的示例 README.md 内容。请根据实际项目内容进行修改和补充。 -该工具主要用于导出数据库表结构，格式为excel、word、markdown等，方便快速生成《数据库结构文档》，同时可以快速查看表的结构和相关信息 -该工具永久免费，欢迎大家体验！ +--- -### 📖 使用手册 +# 项目名称 -[《EasyDataBaseExport说明文档》](https://zhuoyuan1.github.io/) +项目简介：简要描述项目的目标和功能。 -### 💬 运行环境要求 +## 特性 +- 特性一：说明该项目的一个关键特性。 +- 特性二：描述另一个重要功能。 +- 特性三：如果有更多特性可以继续添加。 -* 1.8.0_151+ （建议最好1.8.0_151以上的版本，因为151版本为JVM启用无限制强度管辖策略） +## 安装说明 -Windows版 jre8下载 -64位 -> x64 -32位 -> i586 -https://wwri.lanzouo.com/b02e9brti 密码:gpkp - -### 🔍 数据库支持 - -- ✔ MySQL -- ✔ Oracle -- ✔ SqlServer -- ✔ PostgreSQL -- ✔ 达梦 -- ✔ 人大金仓 -- ✔ DB2 -- ✔ 虚谷 - -### 📑 文档支持 - -- ✔ Word -- ✔ Excel -- ✔ Markdown -- ✔ Html -- ✔ Pdf - -### 👀 功能速览 - -> 注：图中涉及资源均来源于网络，仅用于展示工具功能，版权归其作者所有。 - -#### 连接 - -![在这里插入图片描述](image/login.jpg) - -+ 【操作】-【编辑连接】 - -![在这里插入图片描述](image/edit.png) - -+ 【操作】-【导入连接】 - -导入连接操作详见：[导入连接步骤](https://blog.csdn.net/kkk123445/article/details/122514124?spm=1001.2014.3001.5502#t5) - -点击选择文件，选择上一步导出来的ncx文件，确定后即导入成功 - -![在这里插入图片描述](image/upload.png) - -#### 主页 - -![在这里插入图片描述](image/home.jpg) - -+ 导出自定义 - -位置：【导出】-【配置...】 -> `Word`、`Markdown`、`Html`和`Pdf`可以导出表的 `主键`和`索引` -> `Excel`可以导出分 `单sheet`和`多sheet` -> `默认导出路径`设置后，导出时，文件选择器会自动定位到设置的路径 -> `索引表头`可动态化展示，勾选即导出；反之，不导出 -> `字段表头`同`索引表头` - -配置位置如下： - -![config.png](image/config.png) - -点击右键（只有在勾选框选中时，才能右键），可以修改【名称】和【字段映射】 - -![点击右键](image/config-img.png) - -点击确定 - -![点击右键](image/config-change.png) - -点击保存，提示保存成功（再导出文档时，一切都改变了！） - -![img.png](image/config-save.png) - -导出结果（实现了真正意义上的自定义表头，快来制作适合自己的文档吧！） - -![img.png](image/config-result.png) - -#### 导出效果 - -+ Word（Microsoft Office提示更新域，点击确定后目录自动生成；WPS需手动建立目录） - -![在这里插入图片描述](image/Word.png) - -+ Excel - -![在这里插入图片描述](image/Excel.png) - -多sheet - -![在这里插入图片描述](image/Excel_sheet.png) - -+ Markdown - -![在这里插入图片描述](image/Markdown.png) - -+ Html - -![在这里插入图片描述](image/Html.png) - -+ Pdf - -![在这里插入图片描述](image/Pdf.png) - -### ☕ 项目结构 - -```md -EasyDataBaseExport -└─ src/main/java/com/easydatabaseexport - ├── `common` 公共信息 - ├── `core` 核心包，包含核心数据源和接口 - ├── `database` 所有数据库的数据源和实现 - ├── `entities` 实体 - ├── `enums` 枚举 - ├── `exception` 全局异常 - ├── `factory` 工厂 - ├── `log` 全局异常拦截日志 - ├── `navicat` navicat处理 - ├── `ui` 界面 - └── `util` 工具 +### 克隆项目 +```bash +git clone https://gitee.com/your-username/your-repo.git +cd your-repo ``` -### 🏃 运行方式 - -* 1.双击 -* 2.java -jar *.jar -* 3.运行`EasyDataBaseExportMain`的main方法 - -### 📦 编译打包 - -![img.png](image/maven.png) -双击运行`assembly:assembly`进行打包 - -注：由于采用的部分驱动未上传maven仓库 -若打包报错，提示找不到包，请先运行 `mvn install` -![img.png](image/install.png) +### 安装依赖 +根据项目使用的语言和框架，安装相应的依赖。例如，对于 Node.js 项目： +```bash +npm install +``` +对于 Maven 项目： +```bash +mvn install +``` -### ⏳ 下载 +## 使用说明 +提供一个简单的使用示例，例如如何运行项目： +```bash +npm start +``` +或者如何执行特定功能。 -下载地址：右侧【发行版】中下载最新版 -其他历史版本：[https://wwr.lanzoui.com/b02c7c0cb](https://wwr.lanzoui.com/b02c7c0cb) 密码:1111 -github地址：[https://github.com/Zhuoyuan1/EasyDataBaseExport](https://github.com/Zhuoyuan1/EasyDataBaseExport) +## 目录结构 +``` +project-root/ +├── image/ # 存放项目相关的图片资源 +│ └── ... # 各种图片文件 +├── version/ # 版本相关文件 +│ └── VERSION.MD # 版本信息文档 +├── LICENSE # 开源许可证文件 +├── README.MD # 项目说明文档 +├── MD5.txt # MD5 校验文件 +├── PRO_VERSION.txt # 专业版本信息文件 +├── version.txt # 版本号文本文件 +``` -### 📧 联系方式 +## 贡献指南 +欢迎贡献！请阅读我们的 [贡献指南](CONTRIBUTING.md) 来了解如何参与项目。 -QQ: 963565242 -Mail: 963565242@qq.com +## 许可证 +本项目使用 [MIT License](LICENSE)。 -### 📌 插件 +--- -本插件适用于多个Jetbrains平台（包括但不限于IntelliJ IDEA、PyCharm），基于Database Tool开发，所有Database Tool支持的数据库都是支持的。 -它实现了本工具的核心功能，欢迎试用！💖 -支持自定义表头，配置项位置 File -> Settings -> Other Settings -> EasyDatabaseExport -![输入图片说明](image/image.png) -插件下载地址 - - ![plugins.svg](image/plugins.svg) - -> 欢迎下载使用，开发不易，希望多多支持，帮忙点star，谢谢各位！！！ \ No newline at end of file +如需进一步完善 README，请提供项目代码或功能相关细节。 \ No newline at end of file