知识卡片
工程说明覆盖使用与分发
工程源码之外,还需要让使用者知道项目目标、注意事项及分发约定。README提供上手与使用线索,LICENSE说明项目采用的分发许可文本;它们承担的职责不同于函数注释。
文档可以用Markdown保留纯文本可维护性并展示结构。存在这些文件不表示内容已充分或许可关系已核验,仍应让说明对应真实项目与实际交付方式。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
README:简单介绍本项目目标和关键的注意事项,通常第一次使用时应该先阅读本 文档。 LICENSE:本工程采用的分发协议,所有开源项目通常都有这个文件。 说明文档并不是工程必需的,但如果有的话可以让使用者更快上手
参考来源
- 位置:《Go语言编程 完整版》第07章《工程管理》(来源项目book-sources:extracted/Go语言编程 完整版/_epub-src/text/part0000_split_003.html;spine 4,归一字符[5300,5410))
- 结论依据:原文区分README/LICENSE与代码目录并介绍Markdown表现形式,不提供具体许可法律判断。
- 原始内容:README:简单介绍本项目目标和关键的注意事项,通常第一次使用时应该先阅读本 文档。 LICENSE:本工程采用的分发协议,所有开源项目通常都有这个文件。 说明文档并不是工程必需的,但如果有的话可以让使用者更快上手