Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/github/3.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
在GitHub上指定备用项目级别README.md_Github_Readme - Fatal编程技术网

在GitHub上指定备用项目级别README.md

在GitHub上指定备用项目级别README.md,github,readme,Github,Readme,使用GitHub基于web的界面,我无法确定如何为项目的自述文件指定备用路径/文件名 创建新自述文件时,web界面确实允许我选择使用任意路径或文件名,但我选择的文件不用作项目级自述文件。我希望在用户访问项目页面时显示它 在属于模块或扩展名的项目环境中,例如Magento 1模块在所有此类项目的/README.md处具有所有此类自述文件,这将使它们在最终合并中全部重写,因此应使用替代路径或文件名,例如/docs/projectname/README.md或/projectname.md 如何将该文

使用GitHub基于web的界面,我无法确定如何为项目的自述文件指定备用路径/文件名

创建新自述文件时,web界面确实允许我选择使用任意路径或文件名,但我选择的文件不用作项目级自述文件。我希望在用户访问项目页面时显示它

在属于模块或扩展名的项目环境中,例如Magento 1模块在所有此类项目的/README.md处具有所有此类自述文件,这将使它们在最终合并中全部重写,因此应使用替代路径或文件名,例如/docs/projectname/README.md或/projectname.md

如何将该文件指定为默认自述文件

如果将自述文件放在存储库的根目录、文档目录或隐藏的.github目录中,github将识别并自动向存储库访问者显示自述文件

如果您想为您的项目级自述文件使用另一个文件,我建议您创建一个隐藏的.github/目录,并将您的文件命名为github

在Linux或macOS上,这应该相当简单:

从您的存储库根目录 mkdir.github cd.github ln-s../docs/projectname/some-README.md README.md 在Windows上,事情有点棘手

符号链接仅在Windows Vista或更高版本的NTFS文件系统上可用,创建符号链接需要时间。是的

在Git shell中,在存储库的根目录中,为当前repo启用符号链接:

git config core.symlinks true 现在以管理员的身份运行cmd.exe,并将cd发送到存储库根目录。创建您的符号链接:

mkdir.github cd.github mklink README.md..\docs\projectname\some-README.md 请注意,与上面的Linux和macOS指令相反,此处链接的名称位于实际文件的名称之前。现在可以关闭cmd.exe并返回Git Bash

现在提交.github/README.md并推送到github。您可能需要确保GitHub使用存储库根目录或存储库根目录中的文档/文件夹的任何其他位置都没有真正的自述文件

克隆存储库的Windows用户不会自动获得符号链接。如果他们希望有这种行为,他们应该用一个特殊参数克隆:

git clone-c core.symlinks=true
可以向非管理员用户授予mklink权限,但以管理员身份运行可能是最简单的解决方案。

如果我在主工作站上使用Linux,这将是一个很好的解决方案。我不是。有可能在基于web的界面上实现这一点吗?@Μάκης∏αλάσης,我认为这不能从web实现。你在Windows上吗?@κηη∏αλση,请查看我的最新答案。我已经添加了创建Git将在Windows上尊重的符号链接的说明。