7

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

它工作得很好，但我想在 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 托管服务。

4

5 回答 5

8

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

于 2020-08-05T13:49:42.970 回答
2

Readme.mdGitHub上默认显示的是分支中的那个master。

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

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

您也可以尝试使用子树变得聪明。

于 2020-06-27T19:57:46.693 回答
1

我现在能做的最好的就是链接到关于部分的要点。

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

于 2020-06-25T10:19:58.520 回答
1

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

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

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

于 2020-07-23T15:21:45.397 回答
-4

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

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

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

提交所有更改并运行

git rm -r --cached .

用于重置 git 上的后续文件

于 2020-06-24T19:33:38.943 回答