iT邦幫忙

2022 iThome 鐵人賽

DAY 18
3
Modern Web

我的床邊故事Git and GitHub系列 第 18

第18夜 GitHub README.md

  • 分享至 

  • xImage
  •  

行前提要

正在默默耕耘研究摸索GitHub的小白柚
希望我的闡述方式讓你既明白又深刻
如果有資深大大路過,對於新手上路菜雞的我,
歡迎給予指教與溫柔鞭策(σ`∀´)σ

README.md (使用說明) 可以做些什麼玩些什麼

README是專案自我描述檔案,裡面包括了對專案的基本介紹,可以讓讀者快速瞭解專案
舉例來說 在團隊協作開發時,我們可以在 README.md裡面放一些操作說明
在小白階段,互相提醒一開始的操作模式XDD 例如 :下圖藍色框框內的指令 XDD
https://ithelp.ithome.com.tw/upload/images/20220927/20150181W9JQeRycv1.png
到後來比較成熟一點我們變成專案介紹,看起來是不是有模有樣(>∀・)
https://ithelp.ithome.com.tw/upload/images/20220927/20150181kNyaPDtMTI.png
而且這頁等同於介紹頁,來看看放在GitHub上看起來是怎樣
https://ithelp.ithome.com.tw/upload/images/20220927/20150181hZeFioyixR.png
https://ithelp.ithome.com.tw/upload/images/20220927/20150181JeDwQdIhJ4.png
還提供 Markdown 語法,我們可以在 GitHub 上編輯 ,隨即preview 切換看效果
https://ithelp.ithome.com.tw/upload/images/20220927/20150181wfGTc8ksE9.png

起初在rails new專案時 框架就會順便給我們了如下
https://ithelp.ithome.com.tw/upload/images/20220927/20150181lwQPxtBEW5.png

或者像昨天一樣透過 GitHub 來新增專案
有提供README.md 可要可不要
昨天我有打勾
https://ithelp.ithome.com.tw/upload/images/20220927/20150181lSQiiejkup.png

然後他會長這樣
https://ithelp.ithome.com.tw/upload/images/20220927/20150181IHhGnD4B0G.png

關於README.md 還有一個壓箱寶(只能拿來騙比我更白更菜的那種寶物
那就明天再繼續part 2 吧(σ`∀´)σ


上一篇
第17夜 Git & GitHub .gitignore 檔案
下一篇
第19夜 GitHub README.md (個人頁面)
系列文
我的床邊故事Git and GitHub31
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中
0
阿鵝
iT邦新手 1 級 ‧ 2022-09-28 23:00:40

/images/emoticon/emoticon61.gif

yojijun iT邦新手 4 級 ‧ 2022-09-29 17:57:42 檢舉

/images/emoticon/emoticon33.gif

2
雷N
iT邦研究生 1 級 ‧ 2022-09-28 23:40:54

其實是README.md 拉:)
全大寫檔名有原因的

README file name
There are multiple known names for the readme file. Historically, the most common name README (from jargon file). The reason for the all caps name is that in ASCII systems capital letters comes before small ones. This would make README file sort before all other source code files, which makes it more prominent for the developer.
Other famous forms are README.md, Read.me, Readme.txt, Readme.txt and Readme.1st.

README.md: History and Components

json_liang iT邦研究生 4 級 ‧ 2022-09-28 23:43:10 檢舉

原來如此

yojijun iT邦新手 4 級 ‧ 2022-09-29 00:16:08 檢舉

哇賽 太感恩了!!!!!
學習學習!!!
/images/emoticon/emoticon32.gif

0
json_liang
iT邦研究生 4 級 ‧ 2022-09-28 23:43:25

讀我檔!

yojijun iT邦新手 4 級 ‧ 2022-09-29 11:10:42 檢舉

XD

我要留言

立即登入留言