自述文件通常会记录启动和运行应用程序所需的任何步骤。您可能想要涵盖的内容:

  • Ruby 版系统依赖

  • 配置数据库

  • 创建数据库

  • 初始化数据库

  • 如何运行测试套件

  • 服务(作业队列、缓存服务器、搜索引擎等)

  • 部署说明…

如果您不打算运行 rake doc:app,请随意使用不同的标记语言。