From e747d94396afcfea6210ade336339f4d79b176ef Mon Sep 17 00:00:00 2001 From: Quan Date: Thu, 11 Dec 2025 22:20:41 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=E7=8E=AF=E5=A2=83=E9=85=8D=E7=BD=AE=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 +++++++++++++++++----------- README_EN.md | 28 +++++++++++++++++----------- 2 files changed, 34 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e99b50b..058877d 100644 --- a/README.md +++ b/README.md @@ -80,11 +80,27 @@

⭐ Mac OS、Windows 10 及以上用户可前往 Releases 或者 Actions 下载程序压缩包，解压后打开程序文件夹，双击运行 main 即可使用。

⭐ 本项目包含自动构建可执行文件的 GitHub Actions，使用者可以随时使用 GitHub Actions 将最新源码构建为可执行文件！

⭐ 自动构建可执行文件教程请查阅本文档的 构建可执行文件指南 部分；如果需要更加详细的图文教程，请 查阅文章！

-

注意：由于 Mac OS 平台的可执行文件 main 未经过代码签名，首次运行时会受到系统安全限制。请先在终端执行 xattr -cr main.app 命令移除安全标记，执行一次后即可正常运行。

+

注意：由于 Mac OS 平台的可执行文件 main 未经过代码签名，首次运行时会受到系统安全限制。请先在终端执行 xattr -cr 项目文件夹路径 命令移除安全标记，执行一次后即可正常运行。

若通过此方式使用程序，文件默认下载路径为：.\_internal\Volume\Download；配置文件路径为：.\_internal\Volume\settings.json

程序更新

方案一：下载并解压文件，将旧版本的 _internal\Volume 文件夹复制到新版本的 _internal 文件夹。

方案二：下载并解压文件（不要运行程序），复制全部文件，直接覆盖旧版本文件。

+

⌨️ 源码运行

+
    +
  1. 安装 3.12 版本的 Python 解释器
    2. +
  2. 下载最新的源码或 Releases 发布的源码至本地
    3. +
      使用 pip 安装项目依赖 +
    1. 运行 python -m venv venv 命令创建虚拟环境（可选）
      2. +
    2. 运行 .\venv\Scripts\activate.ps1 或者 venv\Scripts\activate 命令激活虚拟环境（可选）
      3. +
    3. 运行 pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt 命令安装程序所需模块
      4. +
    4. 运行 python .\main.py 或者 python main.py 命令启动 XHS-Downloader
      5. +
    +
      使用 uv 安装项目依赖（推荐） +
    1. 运行 uv venv 命令创建虚拟环境
      2. +
    2. 运行 uv sync 命令同步环境依赖
      3. +
    3. 运行 uv run main.py 命令启动 XHS-Downloader
      4. +
    +

⌨️ Docker 运行

  1. 获取镜像
    2. @@ -108,16 +124,6 @@

Docker 运行项目时不支持 命令行调用模式，无法使用 读取剪贴板 与 监听剪贴板 功能，可以正常粘贴内容，其他功能如有异常请反馈！

-

⌨️ 源码运行

-
    - -[//]: # (
  1. 安装版本号不低于 3.12 的 Python 解释器
    2. ) -
  2. 安装版本号为 3.12 的 Python 解释器
    3. -
  3. 下载本项目最新的源码或 Releases 发布的源码至本地
    4. -
  4. 打开终端，切换至项目根路径
    5. -
  5. 运行 pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt 命令安装程序所需模块
    6. -
  6. 运行 main.py 即可使用
    7. -

🛠 命令行模式

项目支持命令行运行模式，若想要下载图文作品的部分图片，可以使用此模式设置需要下载的图片序号！

注意：未设置 --index 参数时，支持传入多个作品链接，全部链接需要使用引号包围，链接之间使用空格分隔；已设置 --index 参数时，不支持传入多个作品链接，即使传入多个作品链接，程序仅处理首个作品链接！

diff --git a/README_EN.md b/README_EN.md index 330706e..0137aac 100644 --- a/README_EN.md +++ b/README_EN.md @@ -81,11 +81,27 @@

⭐ Mac OS, Windows 10 and above users can go to Releases or Actions to download the program package, unzip it, open the program folder, and double-click to run main to use.

⭐ This project includes GitHub Actions for automatic building executable files. Users can use GitHub Actions to build the latest source code into executable files at any time!

⭐ For the automatic building executable files tutorial, please refer to the Build of Executable File Guide section of this document. If you need a more detailed step-by-step tutorial with illustrations, please check out this article!

-

Note: Due to the macOS platform's executable file main not being code-signed, it will be restricted by system security measures on first run. Please execute the command xattr -cr main.app in the terminal to remove the security flag, after which it can run normally.

+

Note: Due to the macOS platform's executable file main not being code-signed, it will be restricted by system security measures on first run. Please execute the command xattr -cr project_folder_path in the terminal to remove the security flag, after which it can run normally.

If you use the program in this way, the default download path for files is: .\_internal\Volume\Download; the configuration file path is: .\_internal\Volume\settings.json

Update Methods

Method 1: Download and extract the files, then copy the old version of the _internal\Volume folder into the new version's _internal folder.

Method 2: Download and extract the files (do not run the program), then copy all files and directly overwrite the old version.

+

⌨️ Run from Source Code

+
    +
  1. Install Python interpreter version 3.12
    2. +
  2. Download the latest source code or the source code released in Releases to your local machine
    3. +
      Install project dependencies using pip +
    1. Run the command python -m venv venv to create a virtual environment (optional)
      2. +
    2. Run the command .\venv\Scripts\activate.ps1 or venv\Scripts\activate to activate the virtual environment (optional)
      3. +
    3. Run the command pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt to install the required modules for the program
      4. +
    4. Run the command python .\main.py or python main.py to start XHS-Downloader
      5. +
    +
      Install project dependencies using uv (recommended) +
    1. Run the command uv venv to create a virtual environment
      2. +
    2. Run the command uv sync to synchronize environment dependencies
      3. +
    3. Run the command uv run main.py to start XHS-Downloader
      4. +
    +

⌨️ Docker Run

  1. Get Image
    2. @@ -109,16 +125,6 @@

When running the project via Docker, the command line call mode is not supported. The clipboard reading and clipboard monitoring functions are unavailable, but pasting content works fine. Please provide feedback if other features are not functioning properly!

-

⌨️ Source Code Run

-
    - -[//]: # (
  1. Install the Python interpreter with a version no lower than 3.12
    2. ) -
  2. Install Python interpreter with version 3.12
    3. -
  3. Download the latest source code of this project or the source code released in Releases to your local machine
    4. -
  4. Open the terminal and switch to the root path of the project
    5. -
  5. Run the command pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt to install the required modules
    6. -
  6. Run main.py to use
    7. -

🛠 Command Line Mode

The project supports command line mode. If you want to download specific images from a text and image works, you can use this mode to set the image sequence number you want to download!

Note: When the --index parameter is not set, multiple works links can be passed in. All links must be enclosed in quotation marks and separated by spaces. When the --index parameter is set, multiple works links are not supported. Even if multiple links are passed in, the program will only process the first link!