2016-07-27 56 views
0

現在,我正在嘗試創建一個Ruby gem。 我使用bundle gem a_pkg_name生成的gem模板。 然後,自動創建「README.md」,並默認用作gem的文檔。 我可以使用README.org(emacs org-mode文檔)而不是README.md(markdown文檔)嗎? 我知道如果README.md不存在,GitHub同時支持「README」文件和README.org。但是,對於gem,如果README.md不存在,rake build會調用錯誤。如何使用README.org代替README.md用於Ruby gem包

+0

@teksisto謝謝你糾正我的錯字。 – elgoog

回答

1

我的猜測是,你刪除README.md後,提交變更到GIT回購將擺脫錯誤的問題在於

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

而關於包括README.org在你的寶石文檔,您可以通過使用 「extra_rdoc_files」 實現這一目標,

spec.extra_rdoc_files = ['README.org'] 
+0

感謝您提供完整,準確的回答!我可以在我的寶石中添加「README.org」而不是「README.md」。 但是,不幸的是,院子不支持解析emacs org-mode格式.. – elgoog

相關問題