Скажите github использовать пользовательский файл для отображения в качестве README проекта

Question

Есть ли способ сообщить github, что файл readme проекта не README.md, а <project-name>.md?

Answer 1

Создайте каталог с именем .github и добавьте туда README.md, но не обычный файл. Используйте символическую ссылку на файл, который вы хотите быть readme.

 $ mkdir .github
 $ cd .github
 $ ln -s ../project-name.md ./README.md
 $ git add README.md

Answer 2

В документации GitHub указано, что GitHub будет специально отображать содержимое файла с именем README.md, который находится в корне вашего проекта или в подкаталогах .github или docs.

Здесь нет альтернативы, хотя вы можете сделать так, чтобы ваш README.md файл просто содержал ссылку на другую страницу по вашему выбору.