如何在使用裸git存储库管理dotfile时在github上添加README.md但主目录中没有相同的README.md？

2024-05-19 • 问答

我在裸仓库中使用git管理我的dotfile。有关此方法的详细信息，请参见article by Harfang Perch。

它很好用，但是我想在repository on github的根目录中添加一个README.md。

如何将README.md添加到github存储库根目录，但不将文件显示在主目录中？

如果我将README.md推送到github，然后在我的主目录中删除README.md，则会导致

deleted:    README.md

我希望避免的来自git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME status的

消息。

据我所知，github仅在存储库根目录（和子目录，但与该问题无关）中呈现README和README.md文件。

我还没有看到其他带有README.md文件的github dotfile裸存储库，但我只检查了5个。

Github Wiki页面无法解决此问题，除非有某种魔术可以使用隐藏的.dotfile将它们显示在存储库的根目录中。也许我正在抓紧稻草，但是，有没有办法在github上的存储库根目录中链接和显示要点？

我目前不使用gitlab，但是如果他们支持github没有的支持，则有可能迁移到gitlab或类似的git托管服务。

您可以将README文件放在.github文件夹中，它将自动在github上检测到，并显示在您的回购主视图中

目前我能做的最好的就是从“关于”部分链接到要点。

关于部分显示在github存储库页面的右侧。

默认情况下，在GitHub上显示的Readme.md是master分支中的那个。

您可以创建一个没有自述文件的home分支，并将该分支用作工作分支。

您可能希望定期合并以掌握，可以在提交或推送时一次性添加一个或两个方便的别名来完成此操作。

您也可以尝试巧妙地使用子树。

尽管不理想，但一种简单的解决方案是将自述文件和有关配置的任何其他元文件放入跟踪的.dotfiles目录中。然后，您可以在GitHub的repo的about部分中链接到README文件。

在自己尝试此操作后，我意识到我的仓库本身存储在.dotfiles目录中，因此README与内部Git文件混合在一起。但是，将其放在~/.dotfiles/README.md中并进行添加/推送可以按预期进行。如果您不希望混入目录名称，可以尝试使用类似.about的其他目录名称。

提交正确的自述文件文件并将其推送到您的存储库中，

在您的 .gitignore 文件中添加自述文件文件，现在，您可以更改计算机中的自述文件并进行更改了。

如果git不忽略自述文件，请尝试：

提交所有更改并运行

git rm -r --cached .

用于重置git上的后续文件