首页
/ Mathias’s dotfiles 技术文档

Mathias’s dotfiles 技术文档

2024-12-27 12:59:06作者:齐冠琰

1. 安装指南

在尝试使用 Mathias’s dotfiles 之前,请确保先 Fork 此仓库,并仔细审查代码,移除不需要或不适合的部分。除非您了解这些设置的含义,否则请不要盲目使用。使用风险自负!

使用 Git 和引导脚本

您可以将仓库克隆到任何位置(我喜欢将其保存在 ~/Projects/dotfiles,并将 ~/dotfiles 设为符号链接)。引导脚本将会拉取最新版本并将文件复制到您的家目录。

git clone https://github.com/mathiasbynens/dotfiles.git && cd dotfiles && source bootstrap.sh

更新时,进入到本地 dotfiles 仓库,然后:

source bootstrap.sh

若要避免确认提示,更新时可以使用以下命令:

set -- -f; source bootstrap.sh

无 Git 安装

若要无 Git 安装这些 dotfiles:

cd; curl -#L https://github.com/mathiasbynens/dotfiles/tarball/main | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh,.osx,LICENSE-MIT.txt}

更新时,只需再次运行上述命令。

指定 $PATH

若存在 ~/.path 文件,它将在其他文件之前被加载,并在任何功能测试(例如检测使用的 ls 版本)执行前加载。

以下是一个示例 ~/.path 文件,它将 /usr/local/bin 添加到 $PATH

export PATH="/usr/local/bin:$PATH"

添加自定义命令而不创建新的 Fork

如果存在 ~/.extra 文件,它将与其他文件一起被加载。您可以使用它来添加一些自定义命令,无需 Fork 整个仓库,或者添加一些您不希望提交到公共仓库的命令。

我的 ~/.extra 文件看起来像这样:

# Git 凭据
# 不在仓库中,以防止意外以我的名字提交
GIT_AUTHOR_NAME="Mathias Bynens"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="mathias@mailinator.com"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"

您也可以使用 ~/.extra 来覆盖我的 dotfiles 仓库中的设置、函数和别名。不过,更好的做法是 Fork 此仓库

设置合理的 macOS 默认值

新安装 macOS 时,您可能想要设置一些合理的默认值:

./.macos

安装 Homebrew formulae

新安装 Mac 时,您可能想要安装一些常见的 Homebrew formulae(当然,在安装 Homebrew 之后):

./brew.sh

这些 dotfiles 的某些功能依赖于 brew.sh 安装的 formulae。如果您不打算运行 brew.sh,您应该仔细查看脚本并手动安装任何特别重要的 formulae。一个很好的例子是 Bash/Git 完成:dotfiles 使用 Homebrew 的特殊版本。

2. 项目使用说明

  • 使用引导脚本 bootstrap.sh 将配置文件复制到您的家目录。
  • 使用 ~/.path 文件来指定额外的路径。
  • 使用 ~/.extra 文件添加自定义命令或覆盖默认设置。

3. 项目 API 使用文档

本项目不提供 API,它主要是用于配置个人电脑的 dotfiles。

4. 项目安装方式

请参考上述的安装指南来安装本项目。

通过以上步骤,您应该能够成功安装并使用 Mathias’s dotfiles。如果您遇到任何问题或需要帮助,请随时查看项目仓库中的问题追踪部分。

登录后查看全文
热门项目推荐
相关项目推荐