Dotfiles 项目技术文档

本文档旨在帮助用户了解和使用 Dotfiles 项目，包括安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

macOS 安装指南

1. 确保已安装 XCode 或 XCode 命令行工具。在终端中运行 xcode-select --install 并按照提示操作。
2. 克隆 Git 仓库到本地：

export DOTFILES_GH_USER=cowboy
export DOTFILES_GH_BRANCH=master
bash -c "$(curl -fsSL https://raw.github.com/$DOTFILES_GH_USER/dotfiles/$DOTFILES_GH_BRANCH/bin/dotfiles)" && source ~/.bashrc

Ubuntu 安装指南

1. 更新 APT 包管理器：

sudo apt-get -qq update && sudo apt-get -qq dist-upgrade

2. 克隆 Git 仓库到本地：

export DOTFILES_GH_USER=cowboy
export DOTFILES_GH_BRANCH=master
bash -c "$(wget -qO- https://raw.github.com/$DOTFILES_GH_USER/dotfiles/$DOTFILES_GH_BRANCH/bin/dotfiles)" && source ~/.bashrc

2. 项目使用说明

项目的主要使用方式是通过执行 dotfiles 脚本。该脚本会：

1. 在 Ubuntu 上安装 Git（macOS 上已预装）。
2. 克隆当前 Git 仓库到 ~/.dotfiles。
3. 执行 /copy 目录中的文件复制操作。
4. 执行 /link 目录中的文件链接操作。
5. 提示用户选择要执行的初始化脚本。
6. 执行用户选择的初始化脚本。

3. 项目 API 使用文档

本项目不直接提供 API，但是提供了多个可执行的 shell 脚本，用户可以根据需要运行这些脚本来完成特定的配置任务。

4. 项目安装方式

项目的安装方式已在安装指南中详细说明。以下是简要步骤：

1. 克隆 Git 仓库到本地。
2. 设置 DOTFILES_GH_USER 和 DOTFILES_GH_BRANCH 环境变量。
3. 运行 dotfiles 脚本。
4. 源 .bashrc 文件以应用配置。

确保在执行安装脚本时，您可能需要输入密码来完成某些需要管理员权限的操作。

通过上述步骤，用户可以轻松安装和使用 Dotfiles 项目，以便在新的系统上快速配置所需的环境和工具。