当文档在gh页中时,master分支的README文件中应包含什么

时间:2019-10-08 18:20:11

标签: github-pages

我在项目文档中使用了gh-pages分支,但看起来GitHub项目页面需要master分支中的README文件。

似乎我的选择是:

  1. gh-pages中复制master自述文件,然后确保保持同步
  2. master中有一个简单的自述文件,它仅指向文档的GitHub Pages版本

这两个都不是理想的。有更好的方法吗?

2 个答案:

答案 0 :(得分:0)

您可以将“ gh-pages”分支迁移到“ master”分支中的“ docs”子目录。 并创建一个符号链接自述文件-> docs / README.md。

答案 1 :(得分:0)

在README.md文件中,开发人员希望获得有助于更好地理解项目的信息。

仅添加有关项目的关键内容。

有一些提示:

  • 添加有关项目的信息(它做什么,解决什么问题)
  • 列出该项目的所有关键功能
  • 添加该自述文件的内容列表(带有链接)
  • 添加有关如何启动项目以及如何配置的信息
  • 添加一些有用的代码段
  • 如果是开源项目,请添加有关CONTRIBUTION的信息
  • 将您的许可文件的链接添加到自述文件中

认为该README文件与github页面分开。自述文件应包含有用的信息,以帮助开发人员了解项目的用途以及如何使用它。