《macOS 配置 dotfiles 项目使用指南》

1. 项目目录结构及介绍

本项目提供了配置 macOS 系统的 dotfiles，包括 shell 配置、编辑器配置、Git 配置等。以下是项目的目录结构及其介绍：

dotfiles/
├── .editorconfig          # 编辑器配置文件
├── .gitconfig            # Git 全局配置文件
├── .gitignore            # Git 忽略配置文件
├── .nvmrc                # Node.js 版本管理器配置文件
├── .zshrc                # Zsh 配置文件
├── bin/                  # 自定义的二进制脚本
├── colors/               # 自定义颜色主题
├── docs/                 # 文档目录
├── firefox/              # Firefox 浏览器配置
├── fonts/                # 字体文件
├── gpg/                  # GPG 配置
├── lazydocker/           # Lazydocker 配置
├── lazygit/              # Lazygit 配置
├── marta/                # Marta 配置
├── ql-plugins/           # ql-plugins 配置
├── rectangle/            # Rectangle 配置
├── setup/                # 安装脚本目录
├── syntax-highlight/     # 语法高亮配置
├── tilde/                # Tilde 配置
├── vivaldi/              # Vivaldi 浏览器配置
├── vscode/               # VSCode 配置
├── zsh/                  # Zsh 相关配置
├── LICENSE               # 开源协议文件
├── README.md             # 项目说明文件
├── package-lock.json     # 依赖锁定文件
├── package.json          # 项目依赖文件
└── prettier.config.cjs   # Prettier 配置文件

• bin/ 目录包含了一些自定义的脚本文件。
• colors/ 目录包含了一些自定义的颜色主题。
• docs/ 目录包含了项目的文档。
• firefox/ 目录包含了 Firefox 浏览器的配置。
• fonts/ 目录包含了字体文件。
• gpg/ 目录包含了 GPG 的配置。
• lazydocker/ 和 lazygit/ 目录分别包含了 Lazydocker 和 Lazygit 的配置。
• marta/、ql-plugins/、rectangle/、tilde/、vivaldi/ 和 vscode/ 目录分别包含了各种应用和工具的配置。
• setup/ 目录包含了项目的安装脚本。

2. 项目的启动文件介绍

本项目的启动文件主要是 setup/ 目录下的脚本文件，以下是一些主要脚本的介绍：

• zsh.sh：配置 Zsh。
• brew.sh：配置 Homebrew。
• misc.sh：执行一些杂项配置。
• symlinks.sh：在主目录创建符号链接。

使用以下命令运行安装脚本：

cd ~/dotfiles
./setup.sh

该命令会执行 setup/ 目录下的所有脚本，完成项目的初始化和配置。

3. 项目的配置文件介绍

本项目的配置文件包括以下内容：

• .editorconfig：统一的编辑器配置文件，用于各种编辑器之间的代码风格一致性。
• .gitconfig：Git 的全局配置文件，用于设置 Git 的默认行为。
• .gitignore：Git 的忽略配置文件，用于指定不需要提交到版本库的文件。
• .nvmrc：Node.js 版本管理器配置文件，用于指定项目所需的 Node.js 版本。
• .zshrc：Zsh 的配置文件，用于自定义 Zsh 的行为。

这些配置文件在项目目录中被修改后，可以通过以下命令应用到主目录：

cd ~/dotfiles
./setup/symlinks.sh

该命令会在主目录创建指向项目目录中配置文件的符号链接，从而使得修改后的配置立即生效。