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

mak*_*ker 5 git github dotfiles git-repo readme

我在裸存储库中使用 git 管理我的点文件。有关此方法的详细信息,请参阅Harfang Perch 的文章

它工作得很好,但我想将 README.md 添加到github 上存储库的根目录。

如何添加一个README.md到GitHub的版本库的根目录,但具有该文件在我的主目录显示?

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

deleted:    README.md
Run Code Online (Sandbox Code Playgroud)

从消息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 托管服务,则有可能转移到 gitlab 或类似的 git 托管服务。

小智 8

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

  • 这有效:-) 非常感谢您的回答!FWIW您所描述的内容已记录在[此处](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-readmes) (2认同)