meta: add note to readme about git being weird

This commit is contained in:
Erin 2022-11-16 22:06:44 -05:00
parent cc90f63b64
commit e697104122

10
.github/README.md vendored
View file

@ -7,3 +7,13 @@ too many dotfiles
Use [GNU Stow](https://www.gnu.org/software/stow/) (`apt install stow`, etc.). The repo has a `.stowrc` which should target your home directory as the installation directory, but in some cases the `~` may not be evaluated and you'll have to specify `--target="$HOME"`. Use [GNU Stow](https://www.gnu.org/software/stow/) (`apt install stow`, etc.). The repo has a `.stowrc` which should target your home directory as the installation directory, but in some cases the `~` may not be evaluated and you'll have to specify `--target="$HOME"`.
If you're using a shell that does match patterns where `*` doesn't match dotfiles by default (bash, zsh) you can just `cd` into this repo and `stow *` to install everything. You may also want to use `*~kde` (using the `~` exclude token) if you want the dotfiles for all the CLI tools but not my desktop environment shit. Or you can just list the shit you want. If you're using a shell that does match patterns where `*` doesn't match dotfiles by default (bash, zsh) you can just `cd` into this repo and `stow *` to install everything. You may also want to use `*~kde` (using the `~` exclude token) if you want the dotfiles for all the CLI tools but not my desktop environment shit. Or you can just list the shit you want.
## Notes
### Git
Most of my git configuration lives in `~/.config/git/personal.gitconfig`, which is `include`d from `~/.gitconfig`. I do this to separate system-specific configuration that may be set by automated tools (i.e. the Github CLI setting up credential managers for guthub.com and gist.github.com) from my personal, cross-platform configuration (e.g. my identity and aliases).
Keep configuration that should be synced between computers in the `personal.gitconfig` file, and after cloning the repository, consider telling Git to ignore local changes to the main `.gitconfig` file:
git update-index --skip-worktree git/.gitconfig