开源项目的 README 肩负「拉新 + 留存贡献者」的双重任务。在基础结构之上,建议再加这几块。
加分项清单
- Demo / 在线体验:能点开的链接比文字描述强十倍。
- 截图 / GIF:一眼看懂产品形态。
- 路线图 Roadmap:告诉用户下一步去哪,也吸引同路人。
- 致谢 Acknowledgements:尊重依赖与灵感来源。
- FAQ:把 Issue 里的高频问题沉淀下来。
发布前自检
- 别人能否照「安装 + 用法」在 5 分钟内跑起来?
- 有没有 License?
- 有没有一句话说清价值?
用工具生成基础骨架后,把上面加分项手动补上即可。
立即使用 AI README 生成器 →