如何在Ruby包中使用README.org而不是README.md

Question

现在，我正在尝试创建一个Ruby宝石。我使用bundle gem a_pkg_name生成的gem模板。然后，自动创建"README.md“，默认情况下用作gem的文档。我可以使用README.org (emacs模式文档)代替README.md (标记文档)吗？我知道GitHub既支持“自述文件”，又支持README.org，如果README.md不存在，则显示README.md。但是，在gem的情况下，如果rake build不存在README.md，则会调用错误。

Answer 1

我猜问题就在

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

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

关于在gem文档中包含README.org，您可以使用"extra_rdoc_files“来实现这一点，

spec.extra_rdoc_files = ['README.org']

Answer 2

码0.9.10现在支持使用org-ruby的组织模式。https://github.com/lsegal/yard/pull/1133