TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Writing a Friendly README – a short guide on user-focused documentation

5 点作者 rowanmanning大约 9 年前

2 条评论

mchahn大约 9 年前
He neglects to mention the new trend of adding images and in particular screen caps with animated gifs. In my opinion this new trend has been a major improvement to READMEs. I can often just watch the demo to both understand what it is and even how to use it. This helps since I'm often too lazy to read the whole thing.
dozzie大约 9 年前
You may have not noticed with the current Node.js fad, but README does not constitute a documentation. README is just a description of the project, along with some contact information.