我应该如何构建我的README.rdoc文件？ [英] How should I structure my README.rdoc file?
问题描述
我有默认的README.rdoc文件：
I have the default README.rdoc file:
== 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>.
-
使用当前布局。我将如何记录ruby版本，
数据库创建等？
Using the current layout. How would I document the ruby version, database creation etc?
如果我不打算使用
运行'rake doc：app'，我应该使用不同的标记语言。我应该使用另一个标记，还是要求
坚持使用文档的当前格式？
It says I should use a different markup language if I don't plan to run 'rake doc:app'. Should I use another markup or would it be advisable to stick to the current format of the document?
我计划在某些点将我的项目推送到github，但
我注意到默认自述是README.md，这个
与README.rdoc相比吗？
I plan on pushing my project up to github at some point however I've noticed that a the default readme is README.md, how does this compare to README.rdoc?
最后，有没有关于README.rdoc
文件本身的指南或文档？
And finally, is there a guide or documentation about the README.rdoc file itself?
推荐答案
RDoc 是一个非常棒的工具，可以自动生成包含我们记录的代码的格式化HTML。
RDoc is a fantastic tool which enables the automatic generation of formatted HTML containing our documented code.
例如，宝石中的大部分 RubyGems 获取文档并对其进行编译，以提供结果的RDoc 。
For example, most of gems on RubyGems fetch documentation and compiles them to give the resultant rdoc.
现在，回答你的问题。
使用当前的布局。我将如何记录ruby版本，数据库创建等？
Using the current layout. How would I document the ruby version, database creation etc?
我将在 README.rdoc
如果我不打算运行'rake doc：app'，我应该使用不同的标记语言。我应该使用另一个标记，还是建议遵守文档的当前格式？
It says I should use a different markup language if I don't plan to run 'rake doc:app'. Should I use another markup or would it be advisable to stick to the current format of the document?
如果您想要生成的文档RDoc，请坚持使用当前的格式。还有其他的工具和机制来做到这一点。例如 - YARD
Stick to the current format if you want the generated RDoc for your documentation. There are other tools and mechanisms to do that. For example - YARD
我计划在某些时候将我的项目推送到github，但是我注意到默认自述是README.md，与README.rdoc相比如何？ / p>
I plan on pushing my project up to github at some point however I've noticed that a the default readme is README.md, how does this compare to README.rdoc?
如果您的项目没有 README.md ， GitHub 可能会解析 README.rdoc 以显示详细信息。如果它有两个，它将使用 README.md ，默认忽略rdoc。对于Github，通常对于RubyGems的RDoc文档通常都有 README.md 和 README.rdoc 。
If your project doesn't have README.md, GitHub may parse README.rdoc to display details. If it has both, it will use README.md, silently ignoring rdoc. I usually have both, README.md for Github, and README.rdoc for RDoc documentation on RubyGems.
最后，有关于README.rdoc文件本身的指南或文档？
And finally, is there a guide or documentation about the README.rdoc file itself?
呃，我不知道如何回答这个问题。你可以按照你想要的任何格式。在依赖关系，安装，贡献等部分中划分您的详细信息。
Erm, I'm not sure how to answer this. You can follow any format you want to. Divide your details in sections such as Dependencies , Installing, Contributing etc.
希望它有帮助。
这篇关于我应该如何构建我的README.rdoc文件？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
