3

我有点痴迷于我如何记录和组织我的项目。我对自述文件的最佳实践很好奇，并希望了解更多关于其中应该包含的内容。我主要使用导轨。但我相信自述文件不应该对读者做任何假设，并从头开始解释一切。那么，对于 Web 应用程序项目，您理想的描述性永恒自述文件是什么？如果您附上您喜欢的自述文件，这将非常有帮助。

内容？关于应用程序的简短信息？语言，框架？截屏？格式？降价与普通？理想的部署？ETC..

4

1 回答 1

0

如果您不对读者做出假设，那么纯文本是最佳选择。任何标记语言都需要解析和转换，这在本地查看自述文件时可能无法实现。诸如 Github 之类的网站支持各种标记格式，这很好，但您仅限于它们支持的内容。

它的内容条款：它应该解释用户可能想要做的一切，例如编译、构建、运行、修改等。

于 2012-06-21T16:30:17.307 回答