๐Ÿ“˜ Ep.08 | README๋Š” ๋””์ง€ํ„ธ ์ž๊ธฐ์†Œ๊ฐœ์„œ๋‹ค

READ ME ๋Š” ๋””์ง€ํ„ธ ์ž๊ธฐ์†Œ๊ฐœ์„œ๋‹ค โ€” ๋ผ๋Š” ๋ฌธ์žฅ์ด ์“ฐ์ธ ์ˆ˜์ฑ„ํ™” ๋ฐฐ๊ฒฝ์˜ ํƒ€์ดํฌ๊ทธ๋ž˜ํ”ผ ์•„ํŠธ

๐Ÿงญ ์‹œ๋ฆฌ์ฆˆ ์ „์ฒด ๋ณด๊ธฐ โ†’ [๋Šฆ๊นŽ์ด Git ์ž…๋ฌธ์„œ ๋ชฉ์ฐจ]
๐Ÿ“˜ Ep.00 | Prologue. ์™œ ๋‚˜๋Š” Git์„ ๋ฐฐ์šฐ๊ธฐ๋กœ ํ–ˆ๋Š”๊ฐ€?
๐Ÿ“˜ Ep.01 | Git์€ ๋˜๋Œ๋ฆด ์ˆ˜ ์žˆ๋Š” ๋‚˜์˜ ์ผ๊ธฐ์žฅ์ด๋‹ค
๐Ÿ“˜ Ep.02 | Git ์„ค์น˜๋ถ€ํ„ฐ ๋”ฐ๋ผํ•˜๊ธฐ โ€“ ๋‚˜๋งŒ์˜ ํ™˜๊ฒฝ ๋งŒ๋“ค๊ธฐ
๐Ÿ“˜ Ep.03 | git init๊ณผ ์ฒซ ์ปค๋ฐ‹ โ€” ์ด๊ณณ์—์„œ ๊ธฐ๋ก์ด ์‹œ์ž‘๋œ๋‹ค
๐Ÿ“˜ Ep.04 | ์ปค๋ฐ‹์€ ์‹œ๊ฐ„์˜ ๋ถ๋งˆํฌ โ€” log, diff, HEAD
๐Ÿ“˜ Ep.05 | ์‹ค์ˆ˜๋„ ๊ธฐ๋ก์ด๋‹ค โ€” reset๊ณผ revert
๐Ÿ“˜ Ep.06 | ๋‚˜๋งŒ์˜ ํ‰ํ–‰ ์šฐ์ฃผ โ€” ๋ธŒ๋žœ์น˜๋ž€ ๋ฌด์—‡์ธ๊ฐ€?
๐Ÿ“˜ Ep.07 | GitHub๋ž€ ๋ฌด์—‡์ธ๊ฐ€ โ€” ๊ธฐ๋ก์˜ ์ฐฝ๊ณ 
๐Ÿ“˜ Ep.08 | README๋Š” ๋””์ง€ํ„ธ ์ž๊ธฐ์†Œ๊ฐœ์„œ๋‹ค
๐Ÿ“˜ Ep.09 | ๋‚˜๋งŒ์˜ Git ๋ฃจํ‹ด ๋งŒ๋“ค๊ธฐ
๐Ÿ“˜ Ep.10 | Git์œผ๋กœ ์‚ถ์„ ์ •๋ฆฌํ•œ๋‹ค โ€” ๋Šฆ๊นŽ์ด๋“ค์˜ ํšŒ๊ณ ๋ฒ•

๐Ÿชž ์•„๋ฌด๋„ ๋ชจ๋ฅด๋ฉด, ์—†๋Š” ๊ฒƒ๊ณผ ๊ฐ™๋‹ค

์•„๋ฌด๋ฆฌ ์ •์„ฑ๊ป ๋งŒ๋“  ํ”„๋กœ์ ํŠธ๋„

๋ˆ„๊ตฐ๊ฐ€์—๊ฒŒ ์„ค๋ช…ํ•˜์ง€ ์•Š์œผ๋ฉด

๊ทธ๊ฑด ์„ธ์ƒ์— ์—†๋Š” ๊ฒƒ๊ณผ ๊ฐ™๋‹ค.

GitHub๋Š” ์šฐ๋ฆฌ์—๊ฒŒ ๋งํ•œ๋‹ค:

โ€œ๋„ˆ์˜ ๊ธฐ๋ก์„ ์ž˜ ์†Œ๊ฐœํ•ด๋ด.

๊ทธ๊ฑด ๋‹จ์ˆœํ•œ ๊ธฐ์ˆ  ๋ฌธ์„œ๊ฐ€ ์•„๋‹ˆ๋ผ,

๋ˆ„๊ตฐ๊ฐ€๊ฐ€ ๋„ˆ๋ฅผ ์ฒ˜์Œ ๋งŒ๋‚˜๋Š” ๋ฐฉ์‹์ด์•ผ.โ€

๊ทธ๊ฒŒ ๋ฐ”๋กœ README.md์˜ ๋ณธ์งˆ์ด๋‹ค.


๐Ÿ“„ README๋ž€ ๋ฌด์—‡์ธ๊ฐ€?

  • GitHub ์ €์žฅ์†Œ์˜ ๋ฃจํŠธ(root)์— ์žˆ๋Š” README.md ํŒŒ์ผ์€ ์ €์žฅ์†Œ์— ๋“ค์–ด์™”์„ ๋•Œ ๊ฐ€์žฅ ๋จผ์ € ๋ณด์ด๋Š” ๋ฌธ์„œ๋‹ค.
  • .md๋Š” Markdown ํฌ๋งท์„ ์˜๋ฏธํ•ด. ์‰ฝ๊ฒŒ ์“ฐ๊ณ , ๊น”๋”ํ•˜๊ฒŒ ๋ณด์ด๋Š” ๋ฌธ์„œ ํฌ๋งท์ด์ง€.

โœ๏ธ ๊ฐ€์žฅ ๊ธฐ๋ณธ์ ์ธ README ๊ตฌ์กฐ

# ํ”„๋กœ์ ํŠธ ์ด๋ฆ„

์„ค๋ช… ํ•œ ์ค„ โ€” ์ด ํ”„๋กœ์ ํŠธ๋Š” ๋ฌด์—‡์„ ์œ„ํ•œ ๊ฑด๊ฐ€์š”?

## ์‚ฌ์šฉ ๋ฐฉ๋ฒ•

1. ์„ค์น˜
2. ์‹คํ–‰
3. ๊ฒฐ๊ณผ ํ™•์ธ

## ๊ธฐ์—ฌํ•˜๊ธฐ

Pull Request ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค!

## ๋ผ์ด์„ ์Šค

MIT

๋ฌธ๋ฒ•์€ ๊ฐ„๋‹จํ•˜์ง€๋งŒ, ๊ทธ ์‚ฌ๋žŒ์˜ ๊นŠ์ด๊ฐ€ ๋“œ๋Ÿฌ๋‚˜๋Š” ๊ณต๊ฐ„์ด๊ธฐ๋„ ํ•˜์ง€.


๐Ÿ“š ์˜ˆ์œ README ํ…œํ”Œ๋ฆฟ๋„ ๋งŽ๋‹ค

GitHub์—์„œ๋Š”

๋‹ค์–‘ํ•œ README ํ…œํ”Œ๋ฆฟ๋„ ์ฐพ์„ ์ˆ˜ ์žˆ์–ด.

๊ธฐ์ˆ ๋ณด๋‹ค ์ค‘์š”ํ•œ ๊ฑด,

โ€œ๋‚˜์˜ ๊ธฐ๋ก์„ ์–ด๋–ป๊ฒŒ ๋งํ•˜๋А๋ƒโ€๋Š” ํƒœ๋„์•ผ.


๐Ÿ“Œ README๋Š” ๋‚˜๋งŒ์˜ ๊นƒ๋ฐœ์ด๋‹ค

README๋Š” ๋‹จ์ˆœํžˆ โ€œ์„ค๋ช…๋ฌธโ€์ด ์•„๋‹ˆ๋‹ค.

๊ทธ๊ฑด โ€œ์ด ์ €์žฅ์†Œ๊ฐ€ ์–ด๋–ค ์„ธ๊ณ„๊ด€์„ ๋‹ด๊ณ  ์žˆ๋Š”์ง€โ€ ๋ณด์—ฌ์ฃผ๋Š”

๊นƒ๋ฐœ ๊ฐ™์€ ์กด์žฌ๋‹ค.

  • ๊ทธ ๊นƒ๋ฐœ์ด ๋„ˆ์˜ ์ฒ ํ•™์„ ๋งํ•˜๊ณ ,
  • ๊ทธ ๊นƒ๋ฐœ์ด ๋‹ค๋ฅธ ์‚ฌ๋žŒ์„ ๋Œ์–ด๋‹น๊ธฐ๊ณ ,
  • ๊ทธ ๊นƒ๋ฐœ์ด ๊ธฐ๋ก์„ ์‚ด์•„ ์žˆ๊ฒŒ ๋งŒ๋“ ๋‹ค.

โœ๏ธ ๋งˆ๋ฌด๋ฆฌํ•˜๋ฉฐ

์šฐ๋ฆฌ๋Š” ์ด์ œ ๊ธฐ๋ก์„

๋‹จ์ˆœํžˆ ๋‚จ๊ธฐ๋Š” ๊ฒƒ์„ ๋„˜์–ด

์„ค๋ช…ํ•˜๊ณ , ์†Œ๊ฐœํ•˜๊ณ , ๊ณต๊ฐ๋ฐ›๋Š” ๊ธ€๋กœ ๋ฐ”๊พธ๋Š” ์—ฐ์Šต์„ ํ•˜๊ฒŒ ๋๋‹ค.

๊ธฐ๋ก์ด ์™ธ๋ถ€์™€ ์—ฐ๊ฒฐ๋  ๋•Œ,

๊ทธ๊ฑด ๋” ์ด์ƒ ์ผ๊ธฐ๊ฐ€ ์•„๋‹ˆ๋ผ

๋Œ€ํ™”๊ฐ€ ๋œ๋‹ค.

README.md๋Š”

๊ทธ ์ฒซ ๋งˆ๋””๋ฅผ ์—ฌ๋Š” ๋ฌธ์žฅ์ด๋‹ค.


๐Ÿ”– ๋‹ค์Œ ์˜ˆ๊ณ 

๐Ÿ“˜ Ep.09 | ๋‚˜๋งŒ์˜ Git ๋ฃจํ‹ด ๋งŒ๋“ค๊ธฐ

์ฝ”๋ฉ˜ํŠธ

๋‹ต๊ธ€ ๋‚จ๊ธฐ๊ธฐ

์ด๋ฉ”์ผ ์ฃผ์†Œ๋Š” ๊ณต๊ฐœ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ํ•„์ˆ˜ ํ•„๋“œ๋Š” *๋กœ ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค