Readme client是一款为开发人员推出的小工具，可以用来搜索Github里面的README.md，帮助程序员轻松查找项目的开发文档。
Readme client软件介绍
搜集 Github 里的 README.md 。熟悉前端的朋友应该知道一些 js 插件，一般会在 readme.md 里介绍使用方法。而该软件则可以收集，整理，分类。
Readme client使用说明
1. 搜索结果最多显示前30个，建议精确搜索
2. 精准搜索：作者名字/库的名字，如：Hunlongyu/ReadMe-client
3. 模糊搜索：库的名字，如：ReadMe-client。 (注意：中间的空格用 '-' 代替)
README.md文件介绍
README.md文件是一个项目的入门手册，里面介绍了整个项目达到什么样子的效果、需要搭建什么样的环境、具备什么样的技能等等。所以README文件写得好不好，关系到这个项目能不能更容易的被其他人使用。下面详细的介绍一下README.md文件要怎么写可以更好更直观。
README.md文件内容结构
[功能描述]：主要描述一下这个项目的主要功能列表。
[开发环境]：罗列使用本工程项目所需要安装的开发环境及配置，以及所需软件的版本说明和对应的下载链接。
[项目结构简介]：简单介绍项目模块结构目录树，对用户可以修改的文件做重点说明。
[测试DEMO]：此处可以简单介绍一下DEMO程序的思路，具体实现代码放在example文件夹中。
[作者列表]：对于多人合作的项目，可以在这里简单介绍并感谢所有参与开发的研发人员。
[更新链接]：分享后续更新的代码链接。
[历史版本]：对历史版本更改 记录做个简单的罗列，让用户直观的了解到哪些版本解决了哪些问题。
[联系方式]：可以分享微信、邮箱等联系方式，其他人对这个工程不明白的地方可以通过该联系方式与你联系。
下载仅供下载体验和测试学习，不得商用和正当使用。
下载体验