如何使用README.org代替README.md用于Ruby gem包

Question

现在，我正在尝试创建一个Ruby gem。 我使用bundle gem a_pkg_name生成的gem模板。 然后，“README.md”自动创建，默认情况下用作gem的文档。 我可以使用README.org（emacs组织模式文档）而不是README.md（降价文档）吗？ 我知道GitHub支持两个“README”文件，如果README.md不存在，则会显示README.org。但是，在gem的情况下，如果README.md不存在，rake build将调用错误。

Answer 1

Yard 0.9.10现在支持使用org-ruby的org-mode。 https://github.com/lsegal/yard/pull/1133

Answer 2

我的猜测是，问题在于

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

删除README.md后，将更改提交给git repo将消除错误。

关于在您的宝石文档中包含README.org，您可以通过使用＆＃34; extra_rdoc_files＆＃34;，

来实现这一点。

spec.extra_rdoc_files = ['README.org']