From 3360339c08cf968f50c72b17d6c247cadbc0a2c1 Mon Sep 17 00:00:00 2001 From: TianHua Liu <61778232+Taoister39@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:28:42 +0800 Subject: [PATCH] docs: move Windows ARM devices note to CONTRIBUTING.md (#4446) * docs: how to develop locally * docs: move Windows ARM devices note to CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ README.md | 5 ----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07c47b49..32bd99a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,11 @@ Before you start contributing to the project, you need to set up your developmen ### Setup for Windows Users +> [!NOTE] +> **If you are using a Windows ARM device, you additionally need to install [LLVM](https://github.com/llvm/llvm-project/releases) (including clang) and set the environment variable.** +> +> Because the `ring` crate is compiled based on `clang` under Windows ARM. + If you're a Windows user, you may need to perform some additional steps: - Make sure to add Rust and Node.js to your system's PATH. This is usually done during the installation process, but you can verify and manually add them if necessary. @@ -51,11 +56,13 @@ apt-get install -y libxslt1.1 libwebkit2gtk-4.1-dev libayatana-appindicator3-dev You have two options for downloading the clash binary: - Automatically download it via the provided script: + ```shell pnpm run prebuild # Use '--force' to force update to the latest version # pnpm run prebuild --force ``` + - Manually download it from the [Mihomo release](https://github.com/MetaCubeX/mihomo/releases). After downloading, rename the binary according to the [Tauri configuration](https://tauri.app/v1/api/config#bundleconfig.externalbin). ### Run the Development Server diff --git a/README.md b/README.md index 8144554f..15a57c25 100644 --- a/README.md +++ b/README.md @@ -86,11 +86,6 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. To run the development server, execute the following commands after all prerequisites for **Tauri** are installed: -> [!NOTE] -> **If you are using a Windows ARM device, you additionally need to install [LLVM](https://github.com/llvm/llvm-project/releases) (including clang) and set the environment variable.** -> -> Because the `ring` crate is compiled based on `clang` under Windows ARM. - ```shell pnpm i pnpm run prebuild