๋ณธ๋ฌธ ๋ฐ”๋กœ๊ฐ€๊ธฐ
๐ŸŽจ Projects/GitHub

README.md ํŒŒ์ผ์— ํ…Œ์ด๋ธ” ๋งŒ๋“ค๊ธฐ

by HelloRabbit 2023. 3. 24.
728x90

Goal

1. README.md์— ๋งˆํฌ๋‹ค์šด ์–ธ์–ด๋ฅผ ์ด์šฉํ•ด์„œ ํ…Œ์ด๋ธ” ๋งŒ๋“ค๊ธฐ
2. README.md ์˜ˆ์‹œ ๋ณด๊ธฐ

 

๋งˆํฌ๋‹ค์šด ํ…Œ์ด๋ธ” ๋งŒ๋“ค๊ธฐ

ํ—ค๋”์™€ ํ–‰

ํ…Œ์ด๋ธ”์€ ํ—ค๋”์™€ ํ–‰์œผ๋กœ ์ด๋ฃจ์–ด์ ธ ์žˆ์Šต๋‹ˆ๋‹ค.

ํ…Œ์ด๋ธ”

ํ—ค๋”๋Š” ํ…Œ์ด๋ธ”์˜ ์ œ๋ชฉ๋“ค์ด ๋‹ด๊ธด ๊ฐ€์žฅ ์œ„์— ์ค„์— ์žˆ๋Š” ํ–‰์ธ๋ฐ ๋งˆํฌ๋‹ค์šด ์–ธ์–ด์—์„œ๋Š” ํŒŒ์ดํ”„ ์บ๋ฆญํ„ฐ๋ฅผ ์ด์šฉํ•˜๋ฉด ๊ฐ„๋‹จํžˆ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ํŒŒ์ดํ”„ ์บ๋ฆญํ„ฐ๋Š” ์ผ๋ฐ˜์ ์œผ๋กœ ํ‚ค๋ณด๋“œ์—์„œ Enter ๋ฐ”๋กœ ์œ„์— ์žˆ๋Š” ์—ญ์Šฌ๋ž˜์‹œ ๋ฒ„ํŠผ ์„ Shift + ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์ด๋ฆ„ ๊ธฐํ˜ธ
์ผ๋ฐ˜ ์Šฌ๋ž˜์‹œ (slash) /
์—ญ์Šฌ๋ž˜์‹œ (back slash) \
ํŒŒ์ดํ”„ ์บ๋ฆญํ„ฐ (pipe) |

 

ํ—ค๋”

๋งˆํฌ๋‹ค์šด ์–ธ์–ด๋กœ๋Š” ์•„๋ž˜์™€ ๊ฐ™์ด ์“ฐ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

| ํ—ค๋”1 | ํ—ค๋”2 | ํ—ค๋”3 |
| --- | --- | --- |

ํ—ค๋”

 

์ •๋ ฌ

์™ผ์ชฝ, ์˜ค๋ฅธ์ชฝ, ๊ฐ€์šด๋ฐ ์ •๋ ฌ์€ ์•„๋ž˜์™€ ๊ฐ™์ด ์ ์„ ์„ ๋‹ค๋ฅด๊ฒŒ ์“ฐ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

| ๋””ํดํŠธ ์ •๋ ฌ | ์™ผ์ชฝ ์ •๋ ฌ | ์˜ค๋ฅธ์ชฝ ์ •๋ ฌ | ๊ฐ€์šด๋ฐ ์ •๋ ฌ |
| --- | :-- | --: | :-: |
| ๐Ÿฅ• | ๐Ÿฅ• | ๐Ÿฅ• | ๐Ÿฅ• |

์ค„ ์ •๋ ฌ

 

ํ–‰

์œ„์— ์ •๋ ฌํ•  ๋•Œ ํ•œ๊ฑฐ์ฒ˜๋Ÿผ ํ–‰์€ ๋งŒ๋“ค๊ณ  ์‹ถ์€๋งŒํผ ์•„๋ž˜๋กœ ํŒŒ์ดํ”„ ์บ๋ฆญํ„ฐ๋ฅผ ์ด์šฉํ•ด ์ด์–ด๋ถ™์ด๋ฉด ๋ฉ๋‹ˆ๋‹ค.

| ํ—ค๋”1 | ํ—ค๋”2 | ํ—ค๋”3 |
| --- | --- | --- |
| ํ–‰1 ์—ด1 | ํ–‰1 ์—ด2 | ํ–‰1 ์—ด3 |
| ํ–‰2 ์—ด1 | ํ–‰2 ์—ด2 | ํ–‰2 ์—ด3 |
| ํ–‰3 ์—ด1 | ํ–‰3 ์—ด2 | ํ–‰3 ์—ด3 |

ํ–‰

 

 

README.md ์˜ˆ์‹œ

README.md ํŒŒ์ผ

์œ„ README.md๋ฅผ ๋งŒ๋“ค๊ธฐ ์œ„ํ•œ ์ฝ”๋“œ์ž…๋‹ˆ๋‹ค.

# 02_PhotoApp

### โœจ Django๋ฅผ ์ด์šฉํ•œ ์ฒซ ๊ธฐ๋ณธ๊ธฐ ํ”„๋กœ์ ํŠธ!

ํฌ์ŠคํŒ…์˜ ๊ธฐ๋ณธ CRUD ์ค‘ ๋ณด๊ธฐ, ์ž์„ธํžˆ ๋ณด๊ธฐ, ์ƒ์„ฑํ•˜๊ธฐ, ์ˆ˜์ •ํ•˜๊ธฐ ๊ธฐ๋Šฅ์„ ํฌํ•จํ•œ๋‹ค. ๐Ÿ˜Š

</br>

## ํ”„๋กœ์ ํŠธ ๊ฐœ๋ฐœํ™˜๊ฒฝ

| ์†์„ฑ | ๋ฒ„์ „ / ๋„๊ตฌ |
| :-:  | :-: |
| ์šด์˜์ฒด์ œ | Windows 11 Home |
| ํŒŒ์ด์ฌ ๋ฒ„์ „ | 3.10.10 |
| Django ๋ฒ„์ „ | 3.2.10 |
| DRF ๋ฒ„์ „ | 3.13.1 |
| ๊ฐœ๋ฐœ ๋„๊ตฌ | Visual Studio Code (๋ฌด๋ฃŒ) |
| ๊ฐ€์ƒ ํ™˜๊ฒฝ ๋„๊ตฌ | virtualenv |

</br>

## ์ฐธ๊ณ 
๋ฐฑ์—”๋“œ๋ฅผ ์œ„ํ•œ Django Rest Framework with ํŒŒ์ด์ฌ

</br>

 

 

์ฐธ๊ณ 

https://www.pluralsight.com/guides/working-tables-github-markdown

 

 

 

 

๋Œ“๊ธ€