๐ŸŽ€๋ฆณ๊พธ:readme ๊พธ๋ฏธ๊ธฐ (๋ฑƒ์ง€๋„ ๋‹ฌ๊ณ , ๋ฐฐ๊ฒฝ๋„(?) ๊พธ๋ฉฐ๋ณด์ž)

sera Pยท2021๋…„ 9์›” 17์ผ
2

Git์‚ฌ์šฉ๋ฒ•

๋ชฉ๋ก ๋ณด๊ธฐ
3/3
post-thumbnail

์ €๋ฒˆ์—๋Š” ๊ฐ„๋‹จํžˆ ๋งˆํฌ๋‹ค์šด ์–ธ์–ด๋ฅผ ์–ด๋–ป๊ฒŒ ์“ฐ๋Š”์ง€ ์•Œ์•„๋ณด์•˜๋‹ค.
๊ทธ์ดํ›„์—, ๋ฏธ๋ฃจ๊ณ  ๋ฏธ๋ค„์™”๋˜ github Readme๋ฅผ ๋ฐฉ๊ธˆ๊พธ๋ฏธ๊ณ  ๋Œ์•„์™€์„œ ์“ฐ๋Š” TIL.
์—ฌ๋Ÿฌ๊ฐ€์ง€ ๊พธ๋ฏธ๋Š” ๋ฐฉ๋ฒ•๊ณผ ์ƒˆ๋กœ์šด ๋ฑƒ์ง€(?)๋ฅผ ๋ฐœ๊ฒฌํ•ด์„œ ๋‚˜๋ˆ„๊ณ ์ž ์ผ๋‹ค.

1. ์ œ๋ชฉ์—๋Š” ์ด๋ชจํ‹ฐ์ฝ˜(?)

๋‚˜๋Š” ์ œ๋ชฉ์— ์ด๋ชจํ‹ฐ์ฝ˜์„ ์ž์ฃผ ์“ฐ๋Š” ์œ ํ˜•์ด๋‹ค.
๊ทธ๋ž˜์„œ ๋‚ด๊ฐ€๋ณด๋ ค๊ณ  ๋‚จ๊ฒจ๋†“๋Š” ์ด๋ชจํ‹ฐ์ฝ˜ ๊ฐ€์ ธ์˜ค๋Š” ์‚ฌ์ดํŠธ ๋ช‡๊ฐœ..

  • emojipedia : ์ด๋ชจ์ง€๊ณ„์˜ ์œ„ํ‚คํ”ผ๋””์•„ ๊ฐ™์€ ๊ณณ์ด๋‹ค.
    ๋“ค์–ด๊ฐ€์„œ ๊ฒ€์ƒ‰์ฐฝ์— ๊ฒ€์ƒ‰ํ•˜๋ฉด, ๊ฒ€์ƒ‰์–ด์™€ ๊ด€๋ จ๋œ ์ด๋ชจ์ง€๋„ ๋‚˜์˜จ๋‹ค.
    'soccer'์— ๋Œ€ํ•œ ์ƒ์„ธ๊ฒ€์ƒ‰ ํŽ˜์ด์ง€ : ๋ฐ”๋กœ ๋ณต์‚ฌ๋„ ๊ฐ€๋Šฅํ•˜๊ณ , ๊ฐ์ข… ๊ธฐ์—…(?)์—์„œ ์“ฐ๋Š” ์ด๋ชจํ‹ฐ์ฝ˜pngํŒŒ์ผ๋„ ์–ป์„ ์ˆ˜ ์žˆ๋‹ค.์•„๋ž˜๋กœ ๋” ๋‚ด๋ฆฌ๋ฉด, ์œ ๋‹ˆ์ฝ”๋“œ๊ฐ’, github์—์„œ ๋ฐ”๋กœ ์“ธ ์ˆ˜ ์žˆ๋Š” ์ด๋ชจ์ง€์ฝ”๋“œ(:soccer:), ๋ณต๋ถ™์ด ๊ฐ€๋Šฅํ•˜๋‹ค! ์—ฌ๋Ÿฌ๋ชจ๋กœ ์œ ์šฉํ•œ ํŽ˜์ด์ง€ ์ธ๊ฒƒ ๊ฐ™์•„ ๊ณต์œ ํ•œ๋‹ค.
  • webfx.com : ์ด๊ณณ์€ ์ €๋ฒˆ ํ”ผ๋“œ์—์„œ ์†Œ๊ฐœํ•œ ๊ณณ์ด๋‹ค. github์—์„œ ๋ฐ”๋กœ ์“ธ ์ˆ˜ ์žˆ๋Š” ์ฝ”๋“œ๋ฅผ ์ œ๊ณตํ•œ๋‹ค. ์˜ˆ์‹œ) :cat: / :carrot: ์ด๋Ÿฐ๊ฑฐ ๋ณต๋ถ™ํ•ด์„œ ์‚ฌ์šฉ!

2. ๋ฐฐ์ง€ ๋‹ฌ๊ธฐ (์–ธ์–ด, ๊ธฐ์ˆ , ๊ฐœ๋ฐœ ๋„๊ตฌ)

readme์— ๋น ์งˆ ์ˆ˜ ์—†๋Š” ๋ฐฐ์ง€๋‹ฌ๊ธฐ! (๋น ์งˆ์ˆ˜๋„ ์žˆ๋‹ค ใ…Žใ…Ž)
์ž์‹ ์ด ๋Šฅ์ˆ™ํ•œ ํ”„๋กœ๊ทธ๋ž˜๋ฐ ์–ธ์–ด๋‚˜, ๋ฐฐ์šด ๊ธฐ์ˆ , ๋Šฅ์ˆ™ํ•˜๊ฒŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ๊ฐœ๋ฐœ๋„๊ตฌ๋“ฑ์„ ๋ฐฐ์ง€๋ฅผ ํ†ตํ•ด์„œ ๊ฐ„๋‹จํžˆ ๋ณด์—ฌ์ค„ ์ˆ˜ ์žˆ๋‹ค๊ณ  ์ƒ๊ฐํ•œ๋‹ค.

(1) shields.io : ๊ฐ€์žฅ ์œ ๋ช…ํ•˜๊ณ , ์šฐ๋ฆฌ๊ฐ€ ์ตํžˆ ์•Œ๊ณ  ์žˆ๋Š” ๋ฐฐ์ง€ api๋ฅผ ์ œ๊ณตํ•˜๊ณ  ์žˆ๋‹ค.

<!--์œ„์™€ ๊ฐ™์€ ๋ฐฐ์ง€๋ฅผ ์›ํ•œ๋‹ค๋ฉด,  ๊ฐ€์žฅ ๊ธฐ๋ณธ์ด ๋˜๋Š” ์ฝ”๋“œ๋Š” ์•„๋ž˜์™€ ๊ฐ™๋‹ค.-->
<img src="https://img.shields.io/badge/JAVA-007396?
          style=flat&logo=Java&logoColor=white"/>

์ผ๋ฐ˜ํ™”์ฝ”๋“œ

<!--[]๋Š” ์ œ์™ธํ•˜๊ณ  ์‚ฌ์šฉํ•˜๊ณ , ๊ทธ ์•ˆ์—๊ฒƒ์„ ์ž˜ ์ฑ„์šฐ๋ฉด ๋œ๋‹ค.-->
<img src="https://img.shields.io/badge/[์‚ฌ์ง„์† ๋…ธ๋ž€์ƒ‰ ๋ฐ‘์ค„์นœ ๋ถ€๋ถ„์— ๋“ค์–ด๊ฐˆ text]-[๋ฐฐ์ง€๋ฐฐ๊ฒฝ์ƒ‰]?
          style=[๋ฐฐ์ง€์˜ ๋ชจ์–‘ :(plastic, flat, flat-square, for-the-badge, social)์ค‘ ํ•˜๋‚˜๋งŒ ๊ณจ๋ผ ๋„ฃ๋Š”๋‹ค.]
          &logo=[์ •์‹๋กœ๊ณ ๋„ค์ž„]
          &logoColor=[๋นจ๊ฐ„ ํ™”์‚ดํ‘œ์นœ ๋กœ๊ณ ์˜ ์ƒ‰_(์˜์–ด ๋˜๋Š” #๋บ€ ์ƒ‰์ƒhexa๊ฐ’)]"/>
  • [์ •์‹๋กœ๊ณ ๋„ค์ž„]์€ ์—ฌ๊ธฐ์„œ ๊ฐ€์ ธ์˜ค๊ธฐ!
    [์ •์‹๋กœ๊ณ ๋„ค์ž„] : ๋นจ๊ฐ„๋ฐ‘์ค„ ์นœ ๋ถ€๋ถ„ ๊ทธ๋Œ€๋กœ ๋ณต๋ถ™ํ•ด์„œ ๋„ฃ์–ด์ฃผ์„ธ์š”!
    [๋ฐฐ์ง€๋ฐฐ๊ฒฝ์ƒ‰] : ๋…ธ๋ž€๋ฐ‘์ค„์นœ ๋ถ€๋ถ„ ๊ทธ๋Œ€๋กœ ๋ณต๋ถ™ํ•œ ๋‹ค์Œ์— ๊ผญ #๋นผ์ฃผ๊ธฐ!
    (์˜ˆ์‹œ #3776AB >> 3776AB ์ด๋Ÿฐ์‹์œผ๋กœ!)
//์œ„ ์‚ฌ์ง„์—์„œ ๋นจ๊ฐ„๋ฐ‘์ค„์นœ ๋ถ€๋ถ„์ด ์Šคํƒ€์ผ ์œ ํ˜•์ธ๋ฐ, ์ € ๋ถ€๋ถ„์ด ๋ณ€ํ•จ์— ๋”ฐ๋ผ ์˜ค๋ฅธ์ชฝ์ฒ˜๋Ÿผ ๋ณ€ํ•˜๊ฒŒ ๋œ๋‹ค. 
// ์„ ํƒ์ง€๋Š” (plastic, flat, flat-square, for-the-badge, social)์ด ์žˆ๋‹ค.
style=[์—ฌ๊ธฐ๋งŒ๋ฐ”๊ฟ”์ฃผ๋ฉด๋œ๋‹ค]

์˜ˆ์‹œ) ์•„๋ž˜์™€ ๊ฐ™์€ java script ๋ฐฐ์ง€๋ฅผ ๋งŒ๋“ค๊ณ  ์‹ถ๋‹ค!

1) ์ •์‹ ๋กœ๊ณ ๋„ค์ž„ ํ™•์ธ >> ์•„~ [์ •์‹๋กœ๊ณ ๋„ค์ž„] ์€ 'JavaScript'์ด๊ตฌ๋‚˜

2) ๋ฐฐ์ง€ ๋ฐฐ๊ฒฝ์ƒ‰ ์ฐพ๊ธฐ >> ์•„~ [๋ฐฐ์ง€๋ฐฐ๊ฒฝ์ƒ‰]์€ '#F7DF1E'์ด๊ตฌ๋‚˜

3) ๋ฐฐ์ง€ ์Šคํƒ€์ผ ์ •ํ•˜๊ธฐ >> ์ด๊ฑธ๋กœ ํ•ด๋ณด๊ฒ ์–ด >> style=flat

4) img ํƒœ๊ทธ ์ž‘์„ฑํ•˜๊ธฐ

                                      //์ •์‹์ด๋ฆ„-๋ฐฐ์ง€๋ฐฐ๊ฒฝ์ƒ‰ 
<img src="https://img.shields.io/badge/JavaScript-F7DF1E?
          style=flat		//๋ฐฐ์ง€ ์Šคํƒ€์ผ
          &logo=JS		//๋กœ๊ณ ์˜†์— ํ…์ŠคํŠธ
          &logoColor=white"/>	//๋กœ๊ณ  ์ปฌ๋Ÿฌ

(2) ์ปค์Šคํ…€ (?) ๋ฐฐ์ง€ ๋งŒ๋“ค๊ธฐ (abhisheknaiidu๋‹˜์˜ ๊นƒํ—™์ฐธ์กฐ)

  • ๋‹ค์Œ ์‚ฌ์ง„๊ณผ ๊ฐ™์€ ๊ท€์—ฌ์šด ๋ฐฐ์ง€ ๋งŒ๋“ค๊ธฐ
  • ์ฝ”๋“œ (abhisheknaiidu๋‹˜์˜ readme.md์˜ raw code๋ฅผ ๋“ค์—ฌ๋‹ค๋ดค๋‹ค.)
<p>
    <code>
    	<img height="20" 
        src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fb/Adobe_Illustrator_CC_icon.svg/1200px-Adobe_Illustrator_CC_icon.svg.png" 
        style="max-width: 100%;">
     </code>
  </p>
  • ๋ณ€๊ฒฝํ•ด์•ผํ• ๊ฒƒ์€ ๋‹จ ํ•œ๊ฐ€์ง€์ด๋‹ค. ๊ทธ๊ฑด ๋ฐ”๋กœ src
    ์•„์ด์ฝ˜ ์ด๋ฏธ์ง€์˜ ๋งํฌ๋ฅผ ๋ณต์‚ฌํ•ด์„œ ๋„ฃ์–ด์ฃผ๋ฉด ๋์ด๋‹ค.

3. header์™€ footer๊พธ๋ฏธ๊ธฐ

์ด๊ณณ์„ ํด๋ฆญํ•˜๋ฉด, api๊ฐ€ ๋‚˜์™€์žˆ๋Š” ํŽ˜์ด์ง€๋กœ ์—ฐ๊ฒฐ๋œ๋‹ค.

  • ์ด์ฝ”๋“œ๋ฅผ ์‹คํ–‰ํ•˜๋ฉด
//๊ธฐ๋ณธ apiํ˜ธ์ถœ์ด๋‹ค.
<img src="https://capsule-render.vercel.app/api?type=wave&color=auto&height=300&section=header&text=capsule%20render&fontSize=90" />
  • ๊ฒฐ๊ณผ
<img 
src="https://capsule-render.vercel.app/api? //์ด ๋ฌผ์Œํ‘œ ๋’ค์— ๋ถ™๋Š” ์ธ์ž๋“ค์„ ๋ฐ”๊ฟ”์ฃผ๋ฉด ๋œ๋‹ค.
type=wave	//ํ—ค๋”์˜ ๋ชจ์–‘์ด๋‹ค.
&color=auto	//ํ—ค๋”์˜ ์ƒ‰์„ ์–ด๋–ป๊ฒŒ ํ• ๊ฑด์ง€ 
&reversal=true //default=false, ์ƒ‰์˜ ๋ฐฉํ–ฅ์„ ๋ฐ”๊ฟ”์คŒ (gradient์ผ ๊ฒฝ์šฐ)
&height=300	//ํ—ค๋”์˜ ๋†’์ด
&section=header	//ํ—ค๋”์ธ์ง€ ํ‘ธํ„ฐ์ธ์ง€, ๋งŒ์•ฝ footer์ธ ๊ฒฝ์šฐ ๋งจ ์•„๋ž˜ ์ถœ๋ ฅ๋จ
&text=capsule%20render	   //ํ—ค๋”์˜ ๋ฉ”์ธ ํ…์ŠคํŠธ (%20์€ ๋„์–ด์“ฐ๊ธฐ๋ฅผ ๋‚˜ํƒ€๋ƒ„)
&desc=์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค. // description ํ…์ŠคํŠธ
&textBg=true	//๋ฉ”์ธ ํ…์ŠคํŠธ์˜ ๋ฐฐ๊ฒฝํ™”๋ฉด
&fontSize=90 	//ํ—ค๋”์˜ ํฐํŠธ์‚ฌ์ด์ฆˆ
&fontColor=ffee00  //ํฐํŠธ ์ปฌ๋Ÿฌ : hexa๊ฐ’์œผ๋กœ ์ ์–ด๋‘๋˜, #์€ ๋บ„๊ฒƒ!
&animation=fadeIn" //์• ๋‹ˆ๋ฉ”์ด์…˜ ํšจ๊ณผ
/>
  • ๋‚˜๋จธ์ง€ fontAlign, fontAlignX, fontAlignY, descAlign, descAlignX, descAlignY, rotation๋“ฑ์ด ์žˆ๋Š”๋ฐ, API์ฐธ๊ณ  ํ•˜๋ฉด ์‰ฝ๊ฒŒ ํ•  ์ˆ˜ ์žˆ์„ ๊ฒƒ์ด๋‹ค!

์˜ค๋Š˜์€ ์ด์ •๋„๋งŒ ....์ด์ด ๋‹ค์Œ์— ๋˜ ๊ฐ–๊ณ  ์˜ค๊ฒ ๋‹ค.......

profile
๐Ÿฏ developer

0๊ฐœ์˜ ๋Œ“๊ธ€