我对如何记录和组织项目非常着迷。我对自述文件的最佳实践感到好奇，并希望了解更多内容应该包含在内。我主要使用rails。但我相信自述文件不应该对读者做出任何假设，并从头开始解释所有内容。那么对于Web应用程序项目来说，什么是理想的描述性永恒自述文件？如果你附上你喜欢的自述文件，它会非常有用。
的内容？关于app的简短信息？语言，框架？屏幕截图？格式？降价vs平原？理想部署？等。
答案 0 :(得分：0)
如果您不对读者做出假设，那么纯文本是最佳选择。需要解析和转换任何标记语言，这在本地查看自述文件时可能无法实现。诸如Github之类的站点支持各种标记格式，这种格式很好，但是你只能支持它们。
它的内容条款：它应该解释用户可能想要做的所有事情，例如编译，构建，运行，修改等等。