Skip to content

Commit 175b710

Browse files
unknowIfGuestInDreamunknowIfGuestInDream
authored
docs: Improve docs (#2141)
* docs: Improve docs Signed-off-by: unknowIfGuestInDream <[email protected]> * docs: Improve docs Signed-off-by: unknowIfGuestInDream <[email protected]> * docs: Improve docs Signed-off-by: unknowIfGuestInDream <[email protected]> * docs: Improve docs Signed-off-by: unknowIfGuestInDream <[email protected]> --------- Signed-off-by: unknowIfGuestInDream <[email protected]>
1 parent 58342e1 commit 175b710

File tree

14 files changed

+102
-25
lines changed

14 files changed

+102
-25
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# Introduce
1414

1515
[中文文档](./README_zh.md) [日本語文書](./README_jp.md)\
16-
Javafx scaffolding, built on JDK17 + JavaFX21 + controlsfx 11.x.x + Maven
16+
Javafx scaffolding, built on JDK17 + JavaFX 21 + controlsfx 11 + Maven
1717

1818
Frame and login are basic modules, which are pluggable through java SPI to facilitate the integration of application
1919
modules. demo is the provided example module.

‎README_jp.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# はじめに
22

3-
javafx scaffolding, JDK17 + JavaFX21 + controlsfx 11.x.x + Maven
3+
javafx scaffolding, JDK17 + JavaFX 21 + controlsfx 11 + Maven
44

55
frameとloginは基本モジュールで、Java SPI経由でプラグイン可能で、アプリケーションモジュールの統合が容易です。
66
デモはサンプルモジュールです。

‎README_zh.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 介绍
22

3-
javafx脚手架，JDK17 + JavaFX21 + controlsfx 11.x.x + Maven
3+
javafx脚手架，JDK17 + JavaFX 21 + controlsfx 11 + Maven
44

55
frame 和 login 是基础模块, 通过java SPI实现可拔插，方便应用模块集成 demo是提供的示例模块
66

‎core/src/main/java/com/tlcsdm/core/util/CoreConstant.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class CoreConstant {
4141
/**
4242
* JavaFX API
4343
*/
44-
public static final String JAVAFX_API_URL = "https://openjfx.io/javadoc/17";
44+
public static final String JAVAFX_API_URL = "https://openjfx.io/javadoc/21";
4545

4646
/**
4747
* JavaFX CSS API

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 简介
44

5-
JavaFXTool基于JDK17 + JavaFX21 + controlsfx 11 + maven构建的javafx脚手架。
5+
JavaFXTool基于JDK17 + JavaFX 21 + controlsfx 11 + maven构建的javafx脚手架。
66

77
## JavaFXTool中使用的开源软件
88

‎docs/_sidebar.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
- [打包](develop/Package.md)
1010

1111
- Programs
12+
- Common
13+
- [介绍](common/Into.md)
1214
- Smc
1315
- [介绍](smc/Into.md)
1416
- Qe

‎docs/common/Into.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> common: 通用工具

‎docs/develop/Note.md‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
## 依赖更新
22

3-
## 发布版本
3+
当pom.xml中的依赖升级时，由于需要在UI列出使用的依赖信息，因此需要在以下文件中进行相应的修改：
44

5-
## main直接调用
5+
1. docs/README.md
6+
2. core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java
7+
8+
?> Javafx 大版本升级
9+
10+
需要修改以下配置:
11+
12+
1. JavaFX {old version} 全局替换
13+
2. CoreConstant.JAVAFX_API_URL 修改javaFX API路径
14+
15+
?> JDK 大版本升级
16+
17+
需要修改以下配置:
18+
19+
1. JDK{old version} 全局替换
20+
2. 修改Github工作流中的JDK最低支持版本
21+
3. 修改jenkins文件夹下的jre.sh
22+
4. 修改jenkins中的JRE工程
23+
5. 修改jenkins中的javafxTool 使用的JDK版本
24+
25+
?> controlsfx 大版本升级
26+
需要修改以下配置:
27+
28+
1. controlsfx {old version} 全局替换
29+
30+
## 发布新版本
31+
32+
**升级版本号**
33+
当qe或者smc项目要升级版本号时，需要修改以下文件:
34+
35+
1. {program}/src/main/resources/META-INF/MANIFEST.MF 用于IDEA 构建fatjar方式使用
36+
2. {program}/pom.xml 中的{project.version}
37+
3. com.tlcsdm.{program}.util.{program}Constant 下的 PROJECT_VERSION

‎docs/develop/Package.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
## Maven打包
22

3+
**1.可以通过package命令打包**
4+
`mvn package -DskipTests`
5+
打包后生成的文件:
6+
7+
* javafxTool-xxx.jar 项目jar包
8+
* lib 依赖jar包
9+
* CHANGELOG.md 变更日志
10+
* reports/apidocs javadoc文档
11+
* license 第三方license信息
12+
13+
**2.通过maven-assembly-plugin插件打包**
14+
目前在qe和smc中引入了maven-assembly-plugin插件，可以通过 `mvn package -DskipTests -Pzip`打包生成zip产物
15+
maven-assembly-plugin 的配置文件放在qe/smc 下config/zip.xml
16+
17+
!> 如果出现打包引用的core/frame模块源码与当前源码不同时，可以先执行 `mvn install -DskipTests` 将core/frame等模块更新到本地maven仓库
18+
319
## IDEA打包
20+
21+
当使用IDEA开发时，可以使用IDEA提供的构建来生成fatjar
22+
23+
* 配置: 项目结构 -> 工件 -> 新增JAR -> 提取到目标JAR -> 选择自己的清单文件路径 (
24+
src/main/resources/META-INF/MANIFEST.MF) -> 完成
25+
* 打包: 构建 -> 构建工件 -> 构建
26+
27+
目前已提供qe和smc的打包配置，可以直接进行打包，配置文件在 [.idea/artifacts](https://github.com/unknowIfGuestInDream/javafxTool/tree/master/.idea/artifacts ':target=_blank')

‎docs/index.html‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<!-- 作者信息 -->
3232
<meta name="author" content="[email protected]">
3333
<!-- 运用docsify构建 -->
34-
<meta name="generator" content="docsify 4.12.0"/>
34+
<meta name="generator" content="docsify 4.10.0"/>
3535
<meta name="copyright" content="unknowIfGuestInDream">
3636
<meta charset="UTF-8">
3737
<title>JavaFXTool</title>
@@ -47,7 +47,7 @@
4747
<link rel="icon" href="favicon.ico" type="image/x-icon"/>
4848
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon"/>
4949
<link rel=”canonical” href="https://javafxtool.tlcsdm.com"/>
50-
<meta name="description" content="javafx工具，基于JDK17 + JavaFX21 + controlsfx 11.x.x + maven构建的javafx脚手架。">
50+
<meta name="description" content="javafx工具，基于JDK17 + JavaFX 21 + controlsfx 11 + maven构建的javafx脚手架。">
5151
<meta name="viewport"
5252
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
5353
<link rel="stylesheet" media="(prefers-color-scheme: light)" href="themes/theme-simple.css">
@@ -92,14 +92,8 @@
9292
'../smc/$1',
9393
'/qe/(.*)':
9494
'../qe/$1',
95-
'/frame/(.*)':
96-
'../frame/$1',
97-
'/core/(.*)':
98-
'../core/$1',
9995
'/common/(.*)':
10096
'../common/$1',
101-
'/cg/(.*)':
102-
'../cg/$1',
10397
'/.*/_sidebar.md': '../_sidebar.md',//防止意外回退
10498
'/.*/_navbar.md': '../_navbar.md'
10599
},
@@ -142,8 +136,8 @@
142136
//header模块暂时隐藏
143137
var header = [
144138
'<p>',
145-
'<a href="https://www.aliyun.com/sale-season/2020/procurement-new-members?userCode=44mjc0yx">',
146-
'<img src="/images/aliyun_sale.jpg" alt="阿里云" width="640px" height="60px">',
139+
'<a href="https://github.com/unknowIfGuestInDream/javafxTool">',
140+
'<img src="favicon.ico" alt="javafxTool">',
147141
'</a>',
148142
'</p>'
149143
].join('');

0 commit comments

Comments
 (0)