为什么 README 是至关重要的第一印象
当一位开发者访问你的 GitHub 仓库时，他会在几秒钟内做出判断：这个项目值得深入了解吗？值得贡献代码吗？值得在生产环境中使用吗？
这个判断几乎完全取决于你的 README。
然而，大多数开源或私有项目都存在同样的问题：README 不完整、过于技术化、过于模糊，甚至根本不存在。结果就是：有潜力的项目无人问津，潜在的贡献者擦肩而过，团队不得不反复回答同样的基础问题。
好消息是：写出高质量的 README 是可以学会的——而且真的能改变局面。
一份优秀 README 的必备要素
1. 清晰的标题与描述
从最重要的事情开始：用一句话说明你的项目是做什么的。不要堆砌不必要的术语。如果一个不了解你所在领域的人看不懂这句话，请重新表述。
应避免的示例：*