XiangShan Frontend Develop Environment

TLDR

使用以下脚本来布署香山开发环境，部署脚本只需运行一次.：

This script will setup XiangShan develop environment automatically. Note that ./setup-tools.sh and setup.sh only need to be run ONCE.

git clone https://github.com/OpenXiangShan/xs-env
cd xs-env
sudo -s ./setup-tools.sh # use apt to install dependencies, you may modify it to use different pkg manager
source setup.sh # prepare tools, test develop env using a small project

该脚本会默认使用 GraalVM JDK 21，请在运行上述脚本后将环境变量配置到 profile（例如 ~/.bashrc）中：

This script will use GraalVM JDK 21 by default. Please add the following lines to your profile (e.g., ~/.bashrc) after running the above script:

echo 'export PATH="/opt/graalvm-jdk-21/bin:${PATH}"' >> ~/.bashrc
echo 'export JAVA_HOME="/opt/graalvm-jdk-21"' >> ~/.bashrc

如需使用 OpenJDK 21，可以在运行 setup-tools.sh 前设置环境变量 WITH_GRALLVMJDK=false 来禁用 GraalVM JDK 的安装：

If you want to use OpenJDK 21, you can disable GraalVM JDK installation by setting the environment variable WITH_GRALLVMJDK=false before running setup-tools.sh:

sudo -s WITH_GRALLVMJDK=false ./setup-tools.sh

由于香山 master 分支更新频繁，此仓库中的 submodule 默认追踪香山主线分支上的一个稳定提交，并不是香山及其他工具的最新版本。要更新各子仓库到最新版本，可以运行:

Due to the frequent updates of the Xiangshan master branch, the submodule in this repo tracks a stable commit on the Xiangshan master branch by default, not the latest version of Xiangshan and the other tools. To update each submodule to the latest version, run:

source update-submodule.sh

环境部署成功后，每次要使用开发环境时，只需使用以下命令配置环境变量：

After XiangShan Develop Environment setup, use the following script every time before using XiangShan Develop Environment.

cd xs-env
source ./env.sh # setup XiangShan environment variables

Document

详细使用方式请参考完整文档:

For further instructions, see:

XiangShan Frontend Develop Environment Document