README.md

README.md文件是一个项目的入门手册,里面介绍了整个项目的使用、功能等等。所以README文件写得好不好,关系到这个项目能不能更容易的被其他人了解和使用。

README至少要写明项目的功能和使用,这是最基本的,当然,一个好的README想要的不仅仅是功能和使用方法。一般npm包和git上面的项目,当然,好的项目都会有README,这已经是一个约定了。

md是Markdown的缩写,其实READEME就是使用Markdown编写的。README既然是为了让别人了解你这个项目,那么应该如何编写?

国际化:

我们都知道GitHub一般都是使用英语,所以可以的话最好写两个版本,一个是英文,为了所有人能看懂,另一个是中文,为了我们更好的理解。

项目名及简介:

简单介绍一下这个项目是做什么的。有的话最好加上demo地址。

功能:

你这个项目可以实现的功能。

用法:

这可以说是最重要的,一定要让别人看得懂你这项目是怎么使用的。

其他:

作者或者是维护人列表、版权、鸣谢、贡献、logo、联系方式等等,这些有的话当然会更加高大上。

Markdown的语法这边推荐简书上的一篇博客:https://www.jianshu.com/p/191d1e21f7ed

推荐在线Markdown编辑器:https://dillinger.io/,把内容清空之后就能在线练习了。

这边为之前发布的npm包写了个README和添加了keywords:

https://www.npmjs.com/package/wade-tools

这边说一下,之前npm init可以填写的内容,可以直接在package.json直接做修改然后发布。

本文分享自微信公众号 - coding个人笔记(gh_2ce38b49dae1),作者:wade

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-11-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Script标签的async和defer

    之前有写过HTML页面渲染过程,知道了JavaScript是会阻塞DOM解析的,所以我们会把script标签放到底部防止阻塞HTML解析。其实script还有两...

    wade
  • 自己实现一个eventBus

    昨天使用了vue提供的事件发布订阅,于是今天就自己实现了一个,发现没有太大难度,直接上代码:

    wade
  • 雅虎军规第一天

    前端,我一直觉得到了一定程度,那些大牛开发项目已经是拼细节了,因为大方向都是不变的,重要的就是对于细节的把控和对前端的优化。

    wade
  • Silverlight 中的 CoreCLR

    Silverlight 2  包含一个 CLR,但并不是其他 .NET 应用程序和程序集使用的 CLR. Silverlight CLR 也称为 CoreCLR...

    张善友
  • bash: 一键安装pip & 一键设置pip永久镜像

    JNingWei
  • golang flag 命令行参数解析

    copy_left
  • 部署基于flask的api测试平台

    致敬作者 https://github.com/liwanlei/FXTest http://www.cnblogs.com/leiziv5/p/83839...

    98k
  • 将Python打包成可执行文件exe的心路历程

      我们有时候需要将做好的Python程序打包成为一个exe , 方便我们使用,查找了资料发现 pyinstaller 、py2exe,最后还是选择的pyins...

    李家酒馆酒保
  • 工信部全面启动人工智能揭榜,17大领域遴选中国顶级AI单位!

    11月14日,工信部发布关于印发《新一代人工智能产业创新重点任务揭榜工作方案》的通知,启动了人工智能产业创新重点任务揭榜工作,以下称“人工智能揭榜工作”。

    新智元
  • Linux下非常强大的MySQL命令行客户端工具(支持自动补全)

    IDO老徐

扫码关注云+社区

领取腾讯云代金券