Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changing .tc-config in git repo? #6

Open
benlieb opened this issue Apr 11, 2023 · 1 comment
Open

changing .tc-config in git repo? #6

benlieb opened this issue Apr 11, 2023 · 1 comment

Comments

@benlieb
Copy link

benlieb commented Apr 11, 2023

I'm a bit confused by the suggestion to change the .tc-config in the repo. Won't this constantly conflict with pulls?

Wouldn't it be more standard to put this in ~/.tc-config ?

@walkerh
Copy link

walkerh commented May 3, 2024

I agree that using a location outside the repo is the standard. If you must have a file inside the repo directory that the user changes, you should normally add that file to .gitignore and than provide a sample version of the file for users to copy and edit.

Options:

  • Use the existing location, but update the .gitignore file to exclude this file and git mv .tc-config sample.tc-config
  • ${HOME}/.tc-config (less obvious to the user months later what this file is for)
  • ${HOME}/.iterm-color-oh-my-zsh.config (second best option for most software)
  • ${XDG_CONFIG_HOME:-$HOME/.config}/iterm-color-oh-my-zsh/tc.config (most standard compliant)
  • ${XDG_DATA_HOME:-$HOME/.local/share}/iterm-color-oh-my-zsh/tc.config (frequently used but not really for config)
  • ${ZSH_CUSTOM}/config/iterm-color-oh-my-zsh/tc.config (going your own way)

See:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants