Как использовать README.org вместо README.md для пакета Ruby gem

Question

Теперь я пытаюсь создать камень Ruby. Я использую шаблон драгоценного камня, созданный bundle gem a_pkg_name. Затем «README.md» создается автоматически и используется по умолчанию как документ жемчужины. Могу ли я использовать README.org (документ org-mode emacs) вместо README.md (документ уценки)? Я знаю, что GitHub поддерживает файлы README и README.org, если README.md не существует. Однако, в случае gem, rake build вызывает ошибку, если README.md не существует.

Answer 1

Моя догадка, проблема заключается в

spec.files   = `git ls-files -z`.split("\x0") 

После удаления README.md, совершая изменения в мерзавца репо избавится от ошибки.

И о включении README.org в ваших драгоценных документы, вы можете добиться того, что с помощью «extra_rdoc_files»,

spec.extra_rdoc_files = ['README.org'] 

Answer 2

Yard 0.9.10 теперь поддерживает орг-режим с помощью орг-рубин. https://github.com/lsegal/yard/pull/1133