為什么80%的碼農(nóng)都做不了架構(gòu)師？>>> ??

我們在 碼云 上創(chuàng)建新項目的時候，常常會看到默認(rèn)使用 README 文件初始化該項目（如圖1 所示），然后在新建項目的根目錄下就會生成一個 README.md 文件（如圖2 所示）。

圖1 默認(rèn)選中 README

圖2 生成 README 文件

那究竟什么是 README ？它有什么特殊的功能？我們要如何操作才能寫出一個漂亮的 README 呢？

##一、什么是 README.md 文件 ？

一個合格的老司機(jī)想要在 碼云 上了解一個項目，首先都會去翻看該項目的 README 文件，因為這個小小的靜態(tài)文件其實傳達(dá)了整個項目的概述，如項目的介紹、代碼實現(xiàn)的功能、系統(tǒng)環(huán)境參數(shù)、部署要素等。

README 文件后綴名為 md，當(dāng)然擴(kuò)展名也可能是 txt ，rb 等。md 是 markdown 的縮寫，是一種輕量級的「標(biāo)記語言」。它用「標(biāo)記」語法，來代替常見的字處理軟件中大量的排版格式，從而讓大家能夠更專注于文字內(nèi)容，是適合所有人的寫作語言。

大家可以通過以下鏈接來進(jìn)一步學(xué)習(xí) markdown 的寫作：

Markdown 語法說明

Markdown 在線工具

##二、如何玩轉(zhuǎn) 碼云 項目的 README.md？

碼云 上創(chuàng)建 README.md 文件的時候，有一個關(guān)于文件內(nèi)容顯示優(yōu)先級的小竅門分享給大家。

在如圖2 所示的根目錄下，再創(chuàng)建一個新文件 README.osc.md（或者 README-osc.md 或者 README_osc.md），大家會發(fā)現(xiàn)雖然在根目錄下同時存在兩個 README 文件，但項目頁會優(yōu)先顯示含有 osc 的 README 文件中的內(nèi)容。

圖3 README.md 文件中的內(nèi)容

圖4 README.osc.md 文件中的內(nèi)容

圖5 優(yōu)先顯示README.osc.md 內(nèi)容

除此之外，當(dāng)我們使用不同語言創(chuàng)建 README.md 文件時，系統(tǒng)會根據(jù)不同的命名規(guī)范來判斷其顯示的優(yōu)先級，如下所示（優(yōu)先級從左到右）：

• zh-CN 簡體時：zh，cn，zh-cn，zh_cn；

• zh-TW 繁體時：zh-hk，zh-tw，zh-yue，zh_hk，zh_tw，zh_yue；

• en 英文時：en；

##三、README.md 常規(guī)模板

如果 README 包括下面的內(nèi)容，那么當(dāng)使用者打開項目，瀏覽 README 后，基本就知道該如何下手了。

• 項目簡介
• 功能特性
• 環(huán)境依賴
• 部署步驟
• 目錄結(jié)構(gòu)描述
• 版本內(nèi)容更新
• 聲明
• 協(xié)議

當(dāng)然這不是一個絕對的模板，但是其中有些必要的元素（如項目的介紹，使用，部署及目錄結(jié)構(gòu)）還是需要列出來。

如果你也了解 碼云 項目 README 的小竅門，歡迎留言勾搭，分享。如果你還沒有使用過 碼云 的話，也歡迎來試試手~

轉(zhuǎn)載于:https://my.oschina.net/gitosc/blog/846723

總結(jié)

以上是生活随笔為你收集整理的DuangDuangDuang！码云项目的 Readme.md 特殊技能的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。