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

  1. Ruby版系统依赖配置

  2. 数据库创建

  3. 数据库初始化

  4. 如何运行测试套件

  5. 启动服务(如作业队列、缓存服务器、搜索引擎等)

  6. 部署说明

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