git - 将忽略的配置文件作为示例添加到 git repo

Question

我有一个我正在开发的应用程序的存储库，其中包含一个配置文件。目前，我使用 .dist 扩展名进行分发，并让用户在编辑前重命名该文件。

nate:~/myAwesomeApp% git ls-files 
.gitignore
README
config.dist
glorious_support_lib.p
bestProgramEvar.f90

这很好很漂亮，实际的配置被忽略了。

nate:~/myAwesomeApp% cat .gitignore 
config

但是，如果我能以其真实名称分发该配置文件并准备好编辑，同时忽略它，以便新克隆的存储库副本，那将是甜蜜一个“功能性”发行版，它不会被覆盖、破坏或以其他方式骚扰，这样用户就不必担心通过意外的 git commit -a -m 'hurrrr derp!哎呀! && 推送

有没有办法做到这一点？让 git 保留一个被克隆出来的文件的原始版本，但是 此后 被忽略了吗？

我确定以前有人问过这个问题，但对于我来说，我的 google-fu 失败了。好好学习，SO。

Answer 1

我可能会包含某种将“config.dist”复制到“config”的“安装”脚本。

我认为没有办法让一个文件既不被忽略又被忽略。