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

  • Ruby版系统依赖

  • 配置数据库

  • 创建数据库

  • 数据库初始化

  • 如何运行测试套件

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

  • 部署说明

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