docs: README.md, LICENSE

2026-05-25 20:54:40 +08:00 · 2024-09-18 03:27:01 +08:00
parent 9c75f9bf3a
commit fb6c854dc0
2 changed files with 714 additions and 9 deletions
--- a/README.md
+++ b/README.md
@ -1,14 +1,58 @@
-
-#  AList GUI
-
-<br>
 <div>
-    <img alt="JDK" src="https://img.shields.io/badge/JDK-17-%2300599C">
-    <img alt="platform" src="https://img.shields.io/badge/platform-Windows-blueviolet">
+
+# AList GUI
+
+![JDK](https://img.shields.io/badge/JDK-21-%2300599C)
+[![JavaFX](https://img.shields.io/badge/JavaFX-21.0.4-%2300599C)](https://openjfx.io/)
+![platform](https://img.shields.io/badge/platform-Windows-blueviolet)
+<br>
+[![license](https://img.shields.io/github/license/octopusYan/alist-gui)](https://github.com/octopusYan/alist-gui)
+![commit](https://img.shields.io/github/commit-activity/m/octopusYan/alist-gui?color=%23ff69b4)
+<br>
+![stars](https://img.shields.io/github/stars/octopusYan/alist-gui?style=social)
+![GitHub all releases](https://img.shields.io/github/downloads/octopusYan/alist-gui/total?style=social)
+
+使用 JavaFx 编写的 （仿[AList Desktop](https://ad.nn.ci/zh)） Windows GUI
+
 </div>

-<br>
+### TODO

-使用 JavaFx 编写的 AList 桌面图形工具
+#### 本地运行

-### TODO
+1. 克隆代码
+   ```bash
+   git clone https://github.com/octopusYan/alist-gui
+   ```
+2. 运行
+   ```bash
+   mvn clean javafx:run
+   ```
+
+#### 构建
+
+1. 克隆代码
+   ```bash
+   git clone https://github.com/octopusYan/alist-gui
+   ```
+2. 运行
+   ```bash
+   mvn package
+   ```
+
+### 依赖/引用的项目
+
+<figure>
+
+|                                                                             |                 |
+|-----------------------------------------------------------------------------|-----------------|
+| [JavaFX](https://openjfx.io/)                                               | Java 桌面开发       |
+| [AtlantaFX](https://mkpaz.github.io/atlantafx/)                             | JavaFX CSS 主题集合 |
+| [JavaPackager](https://github.com/fvarrui/JavaPackager)                     | 打包插件            |
+| [Ikonli](https://kordamp.org/ikonli/)                                       | 图标库             |
+| [Gluon-Emoji](https://github.com/gluonhq/emoji)                             | emoji           |
+| [Apache Commons](https://commons.apache.org/proper/commons-exec/index.html) | 工具包             |
+| [Hutool](https://doc.hutool.cn/pages/index/)                                | 工具类库            |
+| [SLF4J](https://slf4j.org/)                                                 | 日志工具            |
+
+</figure>