请问HN:你能给一些关于为项目撰写README的建议吗?

1作者: vseplet9 个月前原帖
我目前正在完成我的实验性嵌入式库的初始版本,该库旨在创建无需构建步骤的Web应用程序。但我不确定如何让这个代码库更具吸引力和成功——让人们想要尝试它,甚至可能贡献或改进它。 https://github.com/vseplet/morph?tab=readme-ov-file#morph 因此,我非常感谢您能提供任何关于撰写优秀README或组织代码库的建议,或者指出我在这个过程中可能犯的常见错误。
查看原文
I&#x27;m currently finishing up the initial version of my experimental embeddable library designed for creating web applications without a build step. But I&#x27;m not sure how to make the repository appealing and successful — something that makes people want to try it out, maybe even contribute or improve it.<p>https:&#x2F;&#x2F;github.com&#x2F;vseplet&#x2F;morph?tab=readme-ov-file#morph<p>So, I&#x27;d really appreciate any tips you have on writing a great README or structuring the repo — or pointing out any common mistakes I might have made along the way.