怎么写好README

作者: wangxiaoxi | 来源:发表于2018-09-28 20:05 被阅读0次

README格式

使用Markdown标记语言, 并在在线Markdown编辑器验证

README内容

1. 项目介绍

2. 设计介绍,最好包含解决了什么问题,怎么解决的,当前的状态,后续的进展

3.工具类则应该介绍工具的目的和用法

脚本工具类可参考README 1

常规项目类可参考README 2README 3

相关文章

网友评论

    本文标题:怎么写好README

    本文链接:https://www.haomeiwen.com/subject/aghpoftx.html