怎么寫好README

README格式

使用Markdown標(biāo)記語言,?并在在線Markdown編輯器驗證

README內(nèi)容

1. 項目介紹

2. 設(shè)計介紹，最好包含解決了什么問題，怎么解決的疤坝，當(dāng)前的狀態(tài)倒彰，后續(xù)的進(jìn)展

3.工具類則應(yīng)該介紹工具的目的和用法

腳本工具類可參考README 1

常規(guī)項目類可參考README 2和README 3

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末握侧，一起剝皮案震驚了整個濱河市责嚷，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌掂铐，老刑警劉巖罕拂，帶你破解...
    沈念sama閱讀 210,978評論 6贊 490
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件揍异，死亡現(xiàn)場離奇詭異，居然都是意外死亡爆班，警方通過查閱死者的電腦和手機(jī)衷掷，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,954評論 2贊 384
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來柿菩，“玉大人戚嗅，你說我怎么就攤上這事∈嗖埃” “怎么了懦胞？”我有些...
    開封第一講書人閱讀 156,623評論 0贊 345
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長凉泄。 經(jīng)常有香客問我躏尉，道長，這世上最難降的妖魔是什么后众？ 我笑而不...
    開封第一講書人閱讀 56,324評論 1贊 282
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任胀糜，我火速辦了婚禮，結(jié)果婚禮上蒂誉，老公的妹妹穿的比我還像新娘教藻。我一直安慰自己，他們只是感情好右锨，可當(dāng)我...
    茶點(diǎn)故事閱讀 65,390評論 5贊 384
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布括堤。 她就那樣靜靜地躺著，像睡著了一般陡蝇。 火紅的嫁衣襯著肌膚如雪痊臭。 梳的紋絲不亂的頭發(fā)上，一...
    開封第一講書人閱讀 49,741評論 1贊 289
  • 城市分裂傳說
    那天登夫，我揣著相機(jī)與錄音广匙，去河邊找鬼。 笑死恼策，一個胖子當(dāng)著我的面吹牛鸦致，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播涣楷，決...
    沈念sama閱讀 38,892評論 3贊 405
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼分唾，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了狮斗？” 一聲冷哼從身側(cè)響起绽乔，我...
    開封第一講書人閱讀 37,655評論 0贊 266
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎碳褒，沒想到半個月后折砸，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體看疗，經(jīng)...
    沈念sama閱讀 44,104評論 1贊 303
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評論 2贊 325
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年睦授，在試婚紗的時候發(fā)現(xiàn)自己被綠了两芳。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,569評論 1贊 340
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡去枷，死狀恐怖怖辆，靈堂內(nèi)的尸體忽然破棺而出，到底是詐尸還是另有隱情删顶，我是刑警寧澤竖螃，帶...
    沈念sama閱讀 34,254評論 4贊 328
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布，位于F島的核電站翼闹，受9級特大地震影響斑鼻，放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜猎荠，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,834評論 3贊 312
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一坚弱、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧关摇，春花似錦荒叶、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,725評論 0贊 21
  • 一樁弒父案些楣，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至宪睹，卻和暖如春愁茁，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背亭病。 一陣腳步聲響...
    開封第一講書人閱讀 31,950評論 1贊 264
  • 情欲美人皮
    我被黑心中介騙來泰國打工鹅很， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留，地道東北人罪帖。 一個月前我還...
    沈念sama閱讀 46,260評論 2贊 360
  • 代替公主和親
    正文 我出身青樓促煮，卻偏偏與公主長得像，于是被迫代替她去往敵國和親整袁。 傳聞我的和親對象是個殘疾皇子菠齿，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,446評論 2贊 348

推薦閱讀更多精彩內(nèi)容