???????做一個(gè)項(xiàng)目，首先第一眼看上去要美觀，這樣才有看下去的動(dòng)力。做項(xiàng)目亦是如此，如果每一步應(yīng)付做的話，我想動(dòng)力也不會(huì)太大，最終很大概率會(huì)放棄或者進(jìn)度緩慢。

1.README組成

???????README是對項(xiàng)目的一個(gè)說明，它對觀看者來說是非常重要的一部分。模型結(jié)構(gòu)的說明，訓(xùn)練測試命令都會(huì)寫在這個(gè)文件當(dāng)中。README主要由以下幾部分組成：

(1)項(xiàng)目介紹

(2)代碼功能

(3)操作說明

(4)項(xiàng)目架構(gòu)

2.README書寫方式

???????通常采用markdown語法來書寫README文件。下面是實(shí)現(xiàn)步驟：

???????首先在項(xiàng)目中新建一個(gè)文件，后綴改成.md

???????右鍵使用一個(gè)軟件打開，這里用vscode打開。

???????markdown語法也是需要學(xué)習(xí)的，它跟latex挺像的，只需要掌握一些用法就可以，這里以[2]作為模板，里面包含markdown的一些常用方法。這里以標(biāo)題與正文為例。

???????一個(gè)#代表一級(jí)標(biāo)題，兩個(gè)#代表二級(jí)標(biāo)題，沒有就是正文，我們現(xiàn)在看沒什么區(qū)別，下面我們右鍵選擇預(yù)覽，就會(huì)新彈出一個(gè)預(yù)覽文件，這個(gè)預(yù)覽文件就是最終的效果文件。

???????預(yù)覽后的效果如下：

???????這就是它的最終效果。[1]里面有很多說明，講的很好，這里不做贅述。

3.README如何輸出[4]

???????上面我們預(yù)覽了效果圖，那么我們怎么輸出為這種預(yù)覽的格式呢。下面是兩種方法。

(1)上傳github

???????將項(xiàng)目文件夾（包含?README.md?文件）推送到 GitHub 倉庫。在 GitHub 倉庫的頁面上，README.md?文件會(huì)自動(dòng)渲染為格式化的 HTML，展示在倉庫的主頁上。也就是只要上傳到github上面，它會(huì)自動(dòng)展示成預(yù)覽的效果。

(2)在vscode下載插件并輸出。

???????VS Code 市場中有很多 Markdown 預(yù)覽擴(kuò)展，可以進(jìn)一步增強(qiáng) Markdown 的預(yù)覽和導(dǎo)出功能。

???????Markdown Preview Enhanced：這是一個(gè)功能強(qiáng)大的擴(kuò)展，支持更多的 Markdown 語法和導(dǎo)出選項(xiàng)。安裝?Markdown Preview Enhanced。打開?README.md?文件。使用命令面板（Ctrl+Shift+P?或?Cmd+Shift+P）并選擇?Markdown Preview Enhanced: Open Preview?來預(yù)覽文件。

???????還可以右鍵點(diǎn)擊預(yù)覽區(qū)域，選擇導(dǎo)出為 HTML、PDF 等格式（沒有找到這個(gè)功能）。實(shí)際上就是一個(gè)預(yù)覽功能。輸出我沒找到。上傳到github就可以顯示了。

4.引用博客與網(wǎng)站?

[1]ReadMe 好看指南 - 知乎

[2]github.com

[3]軟件項(xiàng)目規(guī)范（1）：README文件的基本寫作規(guī)范_readme文件怎么寫-CSDN博客

[4]文心一言