怎么写好README
2018-09-28 本文已影响0人
wangxiaoxi
README格式
使用Markdown标记语言, 并在在线Markdown编辑器验证
README内容
1. 项目介绍
2. 设计介绍,最好包含解决了什么问题,怎么解决的,当前的状态,后续的进展
3.工具类则应该介绍工具的目的和用法
脚本工具类可参考README 1
使用Markdown标记语言, 并在在线Markdown编辑器验证
1. 项目介绍
2. 设计介绍,最好包含解决了什么问题,怎么解决的,当前的状态,后续的进展
3.工具类则应该介绍工具的目的和用法
脚本工具类可参考README 1