Readme client是一款為開發(fā)人員推出的小工具,可以用來搜索Github里面的README.md,幫助程序員輕松查找項目的開發(fā)文檔。
Readme client軟件介紹
搜集 Github 里的 README.md 。熟悉前端的朋友應該知道一些 js 插件,一般會在 readme.md 里介紹使用方法。而該軟件則可以收集,整理,分類。
Readme client使用說明
1. 搜索結果最多顯示前30個,建議精確搜索
2. 精準搜索:作者名字/庫的名字,如:Hunlongyu/ReadMe-client
3. 模糊搜索:庫的名字,如:ReadMe-client。 (注意:中間的空格用 '-' 代替)
README.md文件介紹
README.md文件是一個項目的入門手冊,里面介紹了整個項目達到什么樣子的效果、需要搭建什么樣的環(huán)境、具備什么樣的技能等等。所以README文件寫得好不好,關系到這個項目能不能更容易的被其他人使用。下面詳細的介紹一下README.md文件要怎么寫可以更好更直觀。
README.md文件內(nèi)容結構
[功能描述]:主要描述一下這個項目的主要功能列表。
[開發(fā)環(huán)境]:羅列使用本工程項目所需要安裝的開發(fā)環(huán)境及配置,以及所需軟件的版本說明和對應的下載鏈接。
[項目結構簡介]:簡單介紹項目模塊結構目錄樹,對用戶可以修改的文件做重點說明。
[測試DEMO]:此處可以簡單介紹一下DEMO程序的思路,具體實現(xiàn)代碼放在example文件夾中。
[作者列表]:對于多人合作的項目,可以在這里簡單介紹并感謝所有參與開發(fā)的研發(fā)人員。
[更新鏈接]:提供后續(xù)更新的代碼鏈接。
[歷史版本]:對歷史版本更改 記錄做個簡單的羅列,讓用戶直觀的了解到哪些版本解決了哪些問題。
[聯(lián)系方式]:可以提供微信、郵箱等聯(lián)系方式,其他人對這個工程不明白的地方可以通過該聯(lián)系方式與你聯(lián)系。
- PC官方版
- 安卓官方手機版
- IOS官方手機版