如何为项目编写良好 README (quickapp.lovejade.cn)

原文转载自 「技术头条」 ( https://blogread.cn/news/go.php?idItem=13199&url=https://quickapp.lovejade.cn/how-to-write-a-good-readme-for-your-project/?comefrom=https%3A%2F%2Fblogread.cn%2Fnews%2F ) By @杨琼璞

预计阅读时间 0 分钟(共 0 个字, 0 张图片, 0 个链接)

README,它是别人对项目了解、印象的第一来源;尤其是针对开源项目,相当之重要:好比颜值之于一个人,主页之于一个公司;但很多项目并未重视这一点;各种仓库,浩如烟海,没有简洁、明晰的介绍,教人如何耐心去看?本篇文章的存在,即是为了改善这种情况。它将指导您如何写出一篇友好、易读的 README ,同时提供一键生成专业 README(模版)的工具,从而为广大开发者,解决如何书写良好 README 之烦忧;同时为诸多阅读者,缓解没有清晰 README 一窥项目主旨的苦恼。
more_vert