Что должно быть в файле README в основной ветке, когда документы находятся в gh-страницах

Question

Я использую ветвь gh-pages для документации по моему проекту, но похоже, что страница проекта GitHub требует файл README из ветки master.

Похоже, мои варианты:

1. Сделайте копию gh-pages README в master, а затем убедитесь, что они синхронизированы
2. Имейте простой README в master, который просто указывает на страницы GitHubверсия документов

Ни один из них на самом деле не идеален. Есть ли лучший способ сделать это?

Answer 1

В файле README.md разработчики ожидают информацию, которая поможет лучше понять проект.

Добавьте туда только ключевые вещи о проекте.

Есть несколько советов:

• добавить информацию о проекте (что он делает, какую проблему он решает)
• перечислить все ключевые функции этого проекта
• добавить список содержимого этого файла readme (со ссылками)
• добавить информацию о том, как запустить проект и как настроить
• добавить несколько полезных фрагментов кода
• if - проект с открытым исходным кодом, добавьте информацию о CONTRIBUTION
• , добавьте ссылку на ваш файл LICENSE в файл README

Представьте себе этот файл README отдельно от страниц github. Файлы README должны содержать полезную информацию, которая поможет разработчикам понять, что делает проект и как его использовать.

Answer 2

Вы можете перенести ветку "gh-pages" в подкаталог "docs" в ветке "master". И сделайте символическую ссылку README -> docs / README.md.