holman 的 dotfiles 使用与技术文档

本文档旨在帮助用户安装、使用和理解 holman 的 dotfiles 项目。以下内容将详细介绍安装指南、项目使用说明以及项目 API 使用文档。

1. 安装指南

首先，您需要克隆此仓库到您的本地环境：

git clone https://github.com/holman/dotfiles.git ~/.dotfiles

接下来，进入仓库目录并执行 bootstrap 脚本：

cd ~/.dotfiles
script/bootstrap

此脚本将自动创建符号链接，将 .dotfiles 目录中的配置文件链接到您的家目录。所有配置和调整都在 ~/.dotfiles 目录中进行。

2. 项目的使用说明

此项目围绕主题区域构建，使得配置文件的组织更加清晰。以下是一些关键点：

• bin/: 此目录下的所有文件将被添加到您的 $PATH 环境变量中，从而在全局范围内可用。
• topic/*.zsh: 所有以 .zsh 结尾的文件将被加载到您的环境中。
• topic/path.zsh: 所有名为 path.zsh 的文件将首先被加载，用于设置 $PATH 或类似配置。
• topic/completion.zsh: 所有名为 completion.zsh 的文件将最后被加载，用于设置自动补全功能。
• topic/install.sh: 所有名为 install.sh 的文件将在执行 script/install 命令时运行。为了避免自动加载，其扩展名为 .sh 而不是 .zsh。
• topic/*.symlink: 所有以 .symlink 结尾的文件将被符号链接到您的家目录。这样，您可以在 dotfiles 中版本控制这些文件，同时保持它们在家目录中的自动加载。

您可能需要首先修改 zsh/zshrc.symlink 文件，因为其中设置的一些路径可能会根据您的机器不同而有所不同。

dot 脚本是一个简单的脚本，用于安装一些依赖项，设置 macOS 默认值等。您可以调整此脚本，并定期运行 dot 命令来保持您的环境最新。

3. 项目 API 使用文档

本项目主要是用于个人配置，不涉及传统意义上的 API 调用。所有配置文件和脚本都是为了在本地环境中使用。

4. 项目安装方式

项目的安装方式已在“安装指南”中详细说明。简要概括如下：

• 克隆项目到本地环境。
• 进入项目目录。
• 运行 bootstrap 脚本来创建符号链接。

请遵循以上步骤，以成功安装并使用 holman 的 dotfiles 项目。如果您遇到任何问题，请在项目仓库中提出 issue，以便得到解决。