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

How to add README.md on github but not have same README.md in home directory while using a bare git repository for managing dotfiles?

我在裸存储库中使用 git 管理我的点文件。有关此方法的详细信息,请参阅 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 文件。

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

Github wiki 页面不能解决这个问题,除非有一些魔法可以使用隐藏的 .dotfile 将它们显示在存储库的根目录中。也许我抓住了救命稻草,但是,有什么方法可以 link 并在 github 上的存储库根目录中显示要点?

我目前不使用 gitlab,但如果他们支持 gitlab 或类似的 git 托管服务,则有可能43=]集线器没有。

提交正确的 readme 文件并将其推送到您的存储库,

在您的 .gitignore 文件中添加 readme 文件,现在您可以更改计算机中的 readme 文件并毫无问题地提交您的更改。

如果git不忽略自述文件,尝试:

提交所有更改 和 运行

git rm -r --cached . 

用于重置 git

上的后续文件

我现在能做的最好的事情就是 link 到“关于”部分的要点。

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

默认显示在GitHub上的Readme.mdmaster分支中的

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

您可能希望定期合并到 master,您可以添加一两个方便的别名来一次完成此操作,无论是在提交时还是在推送时。


您也可以尝试巧妙地处理子树。

虽然不理想,但一个简单的解决方案是将您的自述文件和任何其他关于您的配置的元文件放入跟踪的 .dotfiles 目录中。然后,您可以 link 在 GitHub.

上您的 repo 的关于部分中的 README 文件

此设置的示例:https://github.com/anandpiyer/.dotfiles

自己尝试后,我意识到我的存储库本身存储在 .dotfiles 目录中,因此 README 与内部 Git 文件混合在一起。但是,将它放在 ~/.dotfiles/README.md 和 adding/pushing 中会按预期工作。如果您不想混入,可以尝试使用不同的目录名称,例如 .about

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