diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6113742
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+此代码库是为`EagleEye2.1.0`（Eclipse基线版本）重新开发注册码生成工具，框架使用JavaFx应用架构。 
+> 当`EagleEye2.1.0`的构建时间版本小于`20231107`时请使用之前的注册码生成工具。
+
+### 开发环境
+- JDK版本：>= 14
+- 构建环境：maven
+
+### 打包为exe
+```shell
+# 1、先使用maven命令构建app-image
+mvn javafx:jlink -f pom.xml
+# 2、使用jpackage命令打包为可执行未见，jdk14以上包含该命令
+jpackage --type app-image -n EagleEyeRegister -m com.keyware.regtool/com.keyware.regtool.Application --runtime-image target\App --temp target\temp --dest target\EagleEyeRegister --icon src\main\resources\logo.ico
+```
\ No newline at end of file