Art of README:README 的艺术
https://github.com/noffle/art-of-readme
和很多 awesome 系列一样是 markdown 编程,作者在本文主要讲述了应该从哪些方面着手,写好一个项目的 readme
? 总结起来有以下几点:
– 一句话解释模块的目的
– 必要的背景资料或链接
– 为潜在不熟悉的术语提供到信息来源的链接
– 简洁可运行的实例
– 安装说明
– 详细的API文档
– 对认知漏斗的执行
– 前面提到的注意事项和限制
– 不要依赖图片传递关键信息
– 许可证