diff --git a/README.md b/README.md index be84b44150b..edf99c4df92 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,16 @@ TRON is building the foundational infrastructure for the decentralized internet Before building java-tron, make sure you have: - Hardware with at least 4 CPU cores, 16 GB RAM, 10 GB free disk space for a smooth compilation process. - Operating system: `Linux` or `macOS` (`Windows` is not supported). -- Git and correct JDK (version `8` or `17`) installed based on your CPU architecture. +- Git and the JDK matching your CPU architecture (see the table below). + +The JDK version required to build or run java-tron is currently tied to the CPU architecture; the two versions are not interchangeable: + +| CPU Architecture | Required JDK | +| :--------------- | :----------- | +| `x86_64` / `amd64` | JDK 8 | +| `ARM64` / `aarch64` | JDK 17 | + +> **Note**: `ARM64` / `aarch64` support is available starting with GreatVoyage-v4.8.1. There are two ways to install the required dependencies: @@ -49,8 +58,6 @@ There are two ways to install the required dependencies: chmod +x install_dependencies.sh ./install_dependencies.sh ``` - > **Note**: For production-grade stability with JDK 8 on x86_64 architecture, Oracle JDK 8 is strongly recommended (the script installs OpenJDK 8). - - **Option 2: Manual installation** Follow the [Prerequisites and Installation Guide](https://tronprotocol.github.io/documentation-en/using_javatron/installing_javatron/#prerequisites-before-compiling-java-tron) for step-by-step instructions. diff --git a/docs/modular-deployment-en.md b/docs/modular-deployment-en.md index c93ba6c39d8..b351ecc7797 100644 --- a/docs/modular-deployment-en.md +++ b/docs/modular-deployment-en.md @@ -4,6 +4,17 @@ After modularization, the recommended way to launch java-tron is via the shell s > **Supported platforms**: Linux and macOS. Windows is not supported. +## Prerequisites + +The JDK version required to build and run java-tron is currently tied to the CPU architecture; the two versions are not interchangeable: + +| CPU Architecture | Required JDK | +| :--------------- | :----------- | +| `x86_64` / `amd64` | JDK 8 | +| `ARM64` / `aarch64` | JDK 17 | + +> **Note**: `ARM64` / `aarch64` support is available starting with GreatVoyage-v4.8.1. + ## Download ``` @@ -45,11 +56,9 @@ java-tron-1.0.0/bin/FullNode -c config.conf -w JVM options can also be specified, located in `bin/java-tron.vmoptions`: ``` -# demo (compatible with JDK 8 / JDK 17) +# Heap-size customization example -Xms2g -Xmx9g --XX:+PrintGCDetails --Xloggc:./gc.log --XX:+PrintGCDateStamps --XX:ReservedCodeCacheSize=256m -``` \ No newline at end of file +``` + +The generated `java-tron.vmoptions` file already contains GC options appropriate for the build architecture and its required JDK. Keep those architecture-specific options when changing the heap size; do not copy GC options between JDK 8 and JDK 17 deployments. diff --git a/docs/modular-deployment-zh.md b/docs/modular-deployment-zh.md index 27cc2ab3856..c73670f23a4 100644 --- a/docs/modular-deployment-zh.md +++ b/docs/modular-deployment-zh.md @@ -4,6 +4,17 @@ > **支持平台**:Linux 和 macOS。不支持 Windows。 +## 环境要求 + +当前,构建和运行 java-tron 所需的 JDK 版本与 CPU 架构绑定,两个版本不能互换: + +| CPU 架构 | 所需 JDK | +| :------- | :------- | +| `x86_64` / `amd64` | JDK 8 | +| `ARM64` / `aarch64` | JDK 17 | + +> **注意**:从 GreatVoyage-v4.8.1 开始支持 `ARM64` / `aarch64` 架构。 + ## 下载 ``` @@ -43,11 +54,9 @@ java-tron-1.0.0/bin/FullNode -c config.conf -w java-tron 支持对 jvm 参数进行配置,配置文件为 bin 目录下的 java-tron.vmoptions 文件。 ``` -# demo(兼容 JDK 8 / JDK 17) +# 堆大小自定义示例 -Xms2g -Xmx9g --XX:+PrintGCDetails --Xloggc:./gc.log --XX:+PrintGCDateStamps --XX:ReservedCodeCacheSize=256m -``` \ No newline at end of file +``` + +生成的 `java-tron.vmoptions` 文件已包含与构建架构及其所需 JDK 匹配的 GC 参数。调整堆大小时请保留这些架构专用参数,不要在 JDK 8 和 JDK 17 部署之间复制 GC 参数。