From 5102999676e0b262342a2705f2ee1aee3a420a45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=B4=80=E1=B4=8D=E1=B4=9B=E1=B4=8F=E1=B4=80=E1=B4=87?= =?UTF-8?q?=CA=80?= Date: Mon, 22 Jul 2024 12:53:41 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BF=AE=E5=A4=8D=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E4=BD=8D=E7=BD=AE=E7=9A=84=E6=8F=8F=E8=BF=B0?= =?UTF-8?q?=E9=94=99=E8=AF=AF=20(#145)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/quick-start.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 726e749..0f1e1a9 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -47,12 +47,21 @@ services: ## 程序配置 -> [!NOTE] -> 在 Docker 环境中,`~` 会被展开为 `/app`。 - 你是否遇到了程序的 panic?别担心,这是正常情况。 -程序默认会将配置文件存储于 `~/.config/bili-sync/config.toml`,数据库文件存储于 `~/.config/bili-sync/data.sqlite`。 +程序默认会将配置文件存储于 `${config_dir}/bili-sync/config.toml`,数据库文件存储于 `${config_dir}/bili-sync/data.sqlite`。 + +> [!CAUTION] +> +> 请注意,`config_dir` 的实际位置与操作系统和用户名有关。 +> +> 对于名为 Alice 的用户,`config_dir` 指向的位置是: +> +> + Lin: `/home/Alice/.config` +> + Win: `C:\Users\Alice\AppData\Roaming` +> + Mac: `/Users/Alice/Library/Application Support` +> +> 特别的,在 Docker 环境中,`config_dir` 会被展开为 `/app/.config`。 在启动时程序会尝试加载配置文件,如果发现不存在会新建并写入默认配置。