我應該如何構建我的README.rdoc文件？

我有默認README.rdoc文件：我應該如何構建我的README.rdoc文件？

== README 

This README would normally document whatever steps are necessary to get the 
application up and running. 

Things you may want to cover: 

* Ruby version 

* System dependencies 

* Configuration 

* Database creation 

* Database initialization 

* How to run the test suite 

* Services (job queues, cache servers, search engines, etc.) 

* Deployment instructions 

* ... 


Please feel free to use a different markup language if you do not plan to run 
<tt>rake doc:app</tt>.

使用當前佈局。我將如何記錄紅寶石版本，數據庫創建等？
它說我應該使用不同的標記語言，如果我不打算運行'rake doc：app'。我應該使用另一種標記，還是建議使用來堅持文檔的當前格式？
我打算在某個時候推我的項目高達github上卻我注意到一個默認的自述是README.md，請問這個比較README.rdoc？
最後，有沒有關於README.rdoc 文件本身的指南或文檔？

來源

2013-10-20 Sheldon

我只是從GitHub上流行的項目中檢查README並遵循這些約定。沒有一種方法可以編寫它。 https://github.com/trending –

RDoc是一個奇妙的工具，它可以自動生成格式化的HTML，包含我們的文檔代碼。

例如，大部分gems在RubyGems獲取文檔並編譯它們以給出resultant rdoc。

現在，回答你的問題。

使用當前佈局。我將如何記錄ruby版本，數據庫創建等？

我將剛纔添加的細節它在README.rdoc

一個部分它說我應該使用不同的標記語言，如果我不打算運行「耙DOC：應用程序」。我應該使用其他標記還是堅持使用當前格式的文檔？

如果您希望爲您的文檔生成RDoc，請堅持使用當前格式。還有其他工具和機制可以做到這一點。例如 - YARD

我打算在某個時候推我的項目高達github上，但是我已經注意到，一個默認的自述是README.md，請問這個比較README.rdoc？

如果你的項目沒有README.md，GitHub可以解析README.rdoc顯示詳細信息。如果它有兩個，它將使用README.md，默默地忽略rdoc。我通常同時擁有Github的README.md和關於RubyGems的RDoc文檔的README.rdoc。

最後，是否有關於README.rdoc文件本身的指南或文檔？

呃，我不知道該如何回答。你可以按照你想要的任何格式。鴻溝部分的細節，如依賴，安裝，特約等

希望它能幫助。

來源

2013-10-20 14:48:42 kiddorails

我應該如何構建我的README.rdoc文件？

回答

相關問題