WhiteRabbit 项目使用教程

1. 项目目录结构及介绍

WhiteRabbit项目的目录结构如下：

.
├── .github
├── .settings
├── docs
├── iniFileExamples
├── rabbit-core
├── rabbitinahat
├── whiterabbit
├── .gitignore
├── .project
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── examples.zip
├── pom.xml

• .github: 包含GitHub特有的配置文件。
• .settings: 包含项目的设置文件。
• docs: 项目文档的存放位置。
• iniFileExamples: 包含配置文件示例。
• rabbit-core: 包含项目核心代码。
• rabbitinahat: 包含RabbitInAHat应用程序的代码。
• whiterabbit: 包含WhiteRabbit应用程序的代码。
• .gitignore: 指定Git忽略的文件和目录。
• .project: 包含IDE项目配置信息。
• CONTRIBUTING.md: 包含贡献指南。
• LICENSE: 项目许可证信息。
• README.md: 项目描述和基本信息。
• examples.zip: 包含示例文件。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

启动文件位于项目的bin目录下，根据操作系统不同，启动方式也有所不同。

• 对于Windows系统，双击bin/whiteRabbit.bat启动WhiteRabbit，双击bin/rabbitInAHat.bat启动RabbitInAHat。
• 对于macOS和Linux系统，双击bin/whiteRabbit启动WhiteRabbit，双击bin/rabbitInAHat启动RabbitInAHat。

如果需要从命令行运行，请参考项目官方文档中的详细说明。

3. 项目的配置文件介绍

项目的配置文件通常位于iniFileExamples目录中，提供了配置文件的示例。用户可以根据自己的需求修改这些配置文件。

• whiteRabbit.ini: 用于配置WhiteRabbit应用程序的参数，例如数据库连接信息、扫描选项等。
• rabbitInAHat.ini: 用于配置RabbitInAHat应用程序的参数。

用户应当参考配置文件示例，根据实际情况调整配置项，以确保应用程序能够正确运行。