添加详细构建指南 (#4524)
This commit is contained in:
56
docs/Building.md
Normal file
56
docs/Building.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# Build Guide
|
||||||
|
|
||||||
|
<!-- #BEGIN LANGUAGE_SWITCHER -->
|
||||||
|
**English** | [中文](Building_zh.md)
|
||||||
|
<!-- #END LANGUAGE_SWITCHER -->
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
To build the HMCL launcher, you need to install JDK 17 (or higher). You can download it here: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts).
|
||||||
|
|
||||||
|
After installing the JDK, make sure the `JAVA_HOME` environment variable points to the required JDK directory.
|
||||||
|
You can check the JDK version that `JAVA_HOME` points to like this:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Windows</summary>
|
||||||
|
|
||||||
|
PowerShell:
|
||||||
|
```
|
||||||
|
PS > & "$env:JAVA_HOME/bin/java.exe" -version
|
||||||
|
openjdk version "25" 2025-09-16 LTS
|
||||||
|
OpenJDK Runtime Environment (build 25+37-LTS)
|
||||||
|
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Linux/macOS/FreeBSD</summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
> $JAVA_HOME/bin/java -version
|
||||||
|
openjdk version "25" 2025-09-16 LTS
|
||||||
|
OpenJDK Runtime Environment (build 25+37-LTS)
|
||||||
|
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## Get HMCL Source Code
|
||||||
|
|
||||||
|
- You can get the latest source code via [Git](https://git-scm.com/downloads):
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/HMCL-dev/HMCL.git
|
||||||
|
cd HMCL
|
||||||
|
```
|
||||||
|
- You can manually download a specific version of the source code from the [GitHub Release page](https://github.com/HMCL-dev/HMCL/releases).
|
||||||
|
|
||||||
|
## Build HMCL
|
||||||
|
|
||||||
|
To build HMCL, switch to the root directory of the HMCL project and run the following command:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./gradlew clean makeExecutables
|
||||||
|
```
|
||||||
|
|
||||||
|
The built HMCL program files are located in the `HMCL/build/libs` subdirectory under the project root.
|
||||||
56
docs/Building_zh.md
Normal file
56
docs/Building_zh.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# 构建指南
|
||||||
|
|
||||||
|
<!-- #BEGIN LANGUAGE_SWITCHER -->
|
||||||
|
[English](Building.md) | **中文**
|
||||||
|
<!-- #END LANGUAGE_SWITCHER -->
|
||||||
|
|
||||||
|
## 环境需求
|
||||||
|
|
||||||
|
构建 HMCL 启动器需要安装 JDK 17 (或更高版本)。你可以从此处下载它: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts)。
|
||||||
|
|
||||||
|
在安装 JDK 后,请确保 `JAVA_HOME` 环境变量指向符合需求的 JDK 目录。
|
||||||
|
你可以这样查看 `JAVA_HOME` 指向的 JDK 版本:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Windows</summary>
|
||||||
|
|
||||||
|
PowerShell:
|
||||||
|
```
|
||||||
|
PS > & "$env:JAVA_HOME/bin/java.exe" -version
|
||||||
|
openjdk version "25" 2025-09-16 LTS
|
||||||
|
OpenJDK Runtime Environment (build 25+37-LTS)
|
||||||
|
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Linux/macOS/FreeBSD</summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
> $JAVA_HOME/bin/java -version
|
||||||
|
openjdk version "25" 2025-09-16 LTS
|
||||||
|
OpenJDK Runtime Environment (build 25+37-LTS)
|
||||||
|
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 获取 HMCL 源码
|
||||||
|
|
||||||
|
- 通过 [Git](https://git-scm.com/downloads) 可以获取最新源码:
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/HMCL-dev/HMCL.git
|
||||||
|
cd HMCL
|
||||||
|
```
|
||||||
|
- 从 [GitHub Release 页面](https://github.com/HMCL-dev/HMCL/releases)可以手动下载特定版本的源码。
|
||||||
|
|
||||||
|
## 构建 HMCL
|
||||||
|
|
||||||
|
想要构建 HMCL,请切换到 HMCL 项目的根目录下,并执行以下命令:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./gradlew clean makeExecutables
|
||||||
|
```
|
||||||
|
|
||||||
|
构建出的 HMCL 程序文件位于根目录下的 `HMCL/build/libs` 子目录中。
|
||||||
@@ -49,13 +49,7 @@ If you want to submit a pull request, here are some requirements:
|
|||||||
|
|
||||||
### Compilation
|
### Compilation
|
||||||
|
|
||||||
Simply execute the following command in the project root directory:
|
See the [Build Guide](./Building.md) page.
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
Make sure you have Java 17 or later installed.
|
|
||||||
|
|
||||||
## JVM Options (for debugging)
|
## JVM Options (for debugging)
|
||||||
|
|
||||||
|
|||||||
@@ -42,13 +42,7 @@ Si deseas enviar un pull request, aquí tienes algunos requisitos:
|
|||||||
|
|
||||||
### Compilación
|
### Compilación
|
||||||
|
|
||||||
Simplemente ejecuta el siguiente comando en el directorio raíz del proyecto:
|
Consulta la página de la [Guía de compilación](./Building.md).
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
Asegúrate de tener instalado Java 17 o una versión posterior.
|
|
||||||
|
|
||||||
## Opciones de JVM (para depuración)
|
## Opciones de JVM (para depuración)
|
||||||
|
|
||||||
|
|||||||
@@ -41,13 +41,7 @@ HMCLが対応しているシステムやCPUアーキテクチャについては
|
|||||||
|
|
||||||
### コンパイル方法
|
### コンパイル方法
|
||||||
|
|
||||||
プロジェクトのルートディレクトリで次のコマンドを実行してください。
|
ビルド方法については、[ビルドガイド](./Building.md)ページをご覧ください。
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
Java 17以上がインストールされていることを確認してください。
|
|
||||||
|
|
||||||
## JVMオプション(デバッグ用)
|
## JVMオプション(デバッグ用)
|
||||||
|
|
||||||
|
|||||||
@@ -42,13 +42,7 @@ HMCL 跨域甚廣。無論 Windows、Linux、macOS、FreeBSD 諸常見械綱,
|
|||||||
|
|
||||||
### 編造
|
### 編造
|
||||||
|
|
||||||
於項目之根目錄,執下列令:
|
請觀[編造指南](./Building_zh.md)。
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
務必保汝已安裝爪哇十七或更高者。
|
|
||||||
|
|
||||||
## 爪哇虛機之通弦(以資勘誤)
|
## 爪哇虛機之通弦(以資勘誤)
|
||||||
|
|
||||||
|
|||||||
@@ -41,13 +41,7 @@ HMCL обладает отличной кроссплатформенность
|
|||||||
|
|
||||||
### Сборка
|
### Сборка
|
||||||
|
|
||||||
Выполните следующую команду в корневой директории проекта:
|
См. страницу [Руководство по сборке](./Building.md).
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
Убедитесь, что у вас установлена Java 17 или новее.
|
|
||||||
|
|
||||||
## Параметры JVM (для отладки)
|
## Параметры JVM (для отладки)
|
||||||
|
|
||||||
|
|||||||
@@ -41,13 +41,7 @@ HMCL має чудові кросплатформні можливості. Ві
|
|||||||
|
|
||||||
### Компіляція
|
### Компіляція
|
||||||
|
|
||||||
Просто виконайте наступну команду в кореневому каталозі проєкту:
|
Дивіться сторінку [Посібник зі збірки](./Building.md).
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
Переконайтеся, що у вас встановлено Java 17 або новішої версії.
|
|
||||||
|
|
||||||
## JVM Options (for debugging)
|
## JVM Options (for debugging)
|
||||||
|
|
||||||
|
|||||||
@@ -47,15 +47,9 @@ HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS、
|
|||||||
* IDE:IntelliJ IDEA
|
* IDE:IntelliJ IDEA
|
||||||
* 编译器:Java 17+
|
* 编译器:Java 17+
|
||||||
|
|
||||||
### 编译
|
### 构建 HMCL
|
||||||
|
|
||||||
于项目根文件夹执行以下命令:
|
参见[构建指南](./Building_zh.md)页面。
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
请确保你至少安装了 JDK 17 或更高版本。
|
|
||||||
|
|
||||||
## JVM 选项 (用于调试)
|
## JVM 选项 (用于调试)
|
||||||
|
|
||||||
|
|||||||
@@ -49,13 +49,7 @@ HMCL 有著強大的跨平臺能力。它不僅支援 Windows、Linux、macOS、
|
|||||||
|
|
||||||
### 編譯
|
### 編譯
|
||||||
|
|
||||||
於項目根目錄執行以下指令:
|
參閱[構建指南](./Building_zh.md)頁面。
|
||||||
|
|
||||||
```bash
|
|
||||||
./gradlew clean build
|
|
||||||
```
|
|
||||||
|
|
||||||
請確保你至少安裝了 JDK 17 或更高版本。
|
|
||||||
|
|
||||||
## JVM 選項 (用於除錯)
|
## JVM 選項 (用於除錯)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user