dotfiles README

The project's README from github.com/mathiasbynens/dotfiles. As one markdown file: README.md.

Mathias’s dotfiles

Screenshot of my shell prompt

Installation

Warning: If you want to give these dotfiles a try, you should first fork this repository, review the code, and remove things you don’t want or need. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

Using Git and the bootstrap script

You can clone the repository wherever you want. (I like to keep it in ~/Projects/dotfiles, with ~/dotfiles as a symlink.) The bootstrapper script will pull in the latest version and copy the files to your home folder.

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

To update, cd into your local dotfiles repository and then:

source bootstrap.sh

Alternatively, to update while avoiding the confirmation prompt:

set -- -f; source bootstrap.sh

Git-free install

To install these dotfiles without Git:

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

To update later on, just run that command again.

Specify the $PATH

If ~/.path exists, it will be sourced along with the other files, before any feature testing (such as detecting which version of ls is being used) takes place.

Here’s an example ~/.path file that adds /usr/local/bin to the $PATH:

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

Add custom commands without creating a new fork

If ~/.extra exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository.

My ~/.extra looks something like this:

# Git credentials
# Not in the repository, to prevent people from accidentally committing under my name
GIT_AUTHOR_NAME="Mathias Bynens"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="[email protected]"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"

You could also use ~/.extra to override settings, functions and aliases from my dotfiles repository. It’s probably better to fork this repository instead, though.

Sensible macOS defaults

When setting up a new Mac, you may want to set some sensible macOS defaults:

./.macos

Install Homebrew formulae

When setting up a new Mac, you may want to install some common Homebrew formulae (after installing Homebrew, of course):

./brew.sh

Some of the functionality of these dotfiles depends on formulae installed by brew.sh. If you don’t plan to run brew.sh, you should look carefully through the script and manually install any particularly important ones. A good example is Bash/Git completion: the dotfiles use a special version from Homebrew.

Feedback

Suggestions/improvements welcome!

Author

twitter/mathias
Mathias Bynens

Thanks to…

dotfiles (mathiasbynens/dotfiles)

Searching Database…

31.5K ·GitHub
Dotfiles
这是什么东西？Mathias Bynens 的个人 dotfiles：macOS 的 shell 配置文件（别名、函数、各种设置），外加几套脚本，用来把新 Mac 按合理的默认值设置好。
所以它不是一个应用——那我装了之后到底能得到什么？就是一些普通文件，复制到你的主文件夹里由 shell 加载，另外还有三个脚本：引导脚本（负责安装和更新这些文件）、用来设置 macOS 合理系统默认值的 ~/.macos，以及安装常用 Homebrew 软件包的 brew.sh。
在我的 Mac 上怎么安装？先复刻（Fork）这个仓库并仔细看看代码。然后把它克隆到你喜欢的任意位置，运行引导脚本——它会把文件复制到你的主文件夹里。也提供了一条不依赖 git 的安装命令作为替代方案。
在一台全新的 Mac 上能直接用吗，还是必须装 Homebrew？有些功能依赖内置 brew.sh 安装的 Homebrew 软件包——比如 Bash/Git 的自动补全用的就是 Homebrew 里的特殊版本。如果你跳过 brew.sh，请查看脚本内容，手动安装那些重要的软件包。
我能不改动直接在自己电脑上运行吗？作者请你不要这么做：先复刻（Fork）仓库，审阅代码，删掉你不需要或不想要的内容。这些是他个人的设置，使用风险由你自己承担。
作者自己把这份仓库放在哪里？放哪儿都行——他把仓库放在 ~/Projects/dotfiles，然后创建一个指向它的 ~/dotfiles 符号链接。
以后怎么更新这些 dotfiles？cd 进入你本地的 dotfiles 仓库，再次运行引导脚本——它会拉取最新版本并重新复制文件。不依赖 git 的安装方式也是同样更新：再跑一遍那条命令就行。
能不能不复制整个仓库就添加我自己的别名？可以——有两个可选文件：~/.path 会在启动早期被加载，用来扩展 $PATH；~/.extra 会和其他文件一起加载，用来放自定义命令，或覆盖仓库自带的函数和别名。不过作者还是觉得复刻（Fork）整个仓库多半更好。
What are similar projects?direnv, awesome-dotfiles, oh-my-fish, tpm, oh-my-posh, dotfiles, .tmux, tmuxinator
Which topics is it in?click, tweaks, dotfiles, script, prompt, configuration, bash, homebrew, git, shell, customization, terminal
Creator
mathiasbynens
Size
0.8 MB
Stars
31.5K
Updated
CommitApr 09
Age
15y
Commits · 90 Days