[B! github][README] mimosafaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

mimosafa id:mimosafa

githubã¨READMEã«é–¢ã™ã‚‹mimosafaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (3)

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

${{author_name}}$
{{author_name}}{{created}}
{{ #comment }}{{ comment }}{{ /comment }}
- {{ label }}

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

ã‚ã‹ã‚Šã‚„ã™ã„ README é§†å‹•é–‹ç™º - Qiita
å··ã«ã¯ README é§†å‹•é–‹ç™ºï¼ˆReadme Driven Development; RDDï¼‰ãªã‚‹ã‚‚ã®ãŒã‚ã‚‹ã‚ˆã†ã§ã€ã¨ã¦ã‚‚åˆç†çš„ã§ã‹ã¤ä¾¿åˆ©ã§ã‚ã£ãŸã®ã§ç´¹ä»‹ã—ã¾ã™ã€‚ README é§†å‹•é–‹ç™ºï¼ˆä»¥ä¸‹ã€RDDï¼‰ã¨ã¯ãã®åã®é€šã‚Šã€README ã‚ã‚Šãã®é–‹ç™ºã‚¹ã‚¿ã‚¤ãƒ«ã®ã“ã¨ã§ã€ç°¡å˜ã«è¨€ã†ã¨ã€Œã‚³ãƒ¼ãƒ‰æ›¸ãå‰ã« README æ›¸ãã€ã£ã¦ã“ã¨ã§ã™ã€‚ é–‹ç™ºã«å…¥ã‚‹å‰ã«ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã€ã¨ã„ã†ã¾ã‚å½“ãŸã‚Šå‰ã§ã‚ã‚‹ã‚ˆã†ã§ã¡ã‚‡ã£ã¨ã—ãŸãƒ„ãƒ¼ãƒ«ã§ã¯è”‘ã‚ã«ã—ãŒã¡ãªã“ã¨ã§ã™ã‚ˆãã€‚ ã‚ã‹ã‚Šã‚„ã™ã„README.mdã‚’æ›¸ã - SOTA Readmeé§†å‹•é–‹ç™ºã‚’å’Œè¨³ã—ã¦ã¿ãŸ - Qiita Readmeé§†å‹•é–‹ç™ºã‚’å’Œè¨³ã—ã¦ã¿ãŸ - ç”Ÿæ¶¯æœªç†Ÿ å®Ÿè·µçš„ãªREADMEé§†å‹•ã«ã¤ã„ã¦ - GH Issue Note RDD ã®ãƒ¡ãƒªãƒƒãƒˆ ãƒ¢ãƒãƒ™ãƒ¼ã‚·ãƒ§ãƒ³ãŒé«˜ã„ã¨ãã«æ›¸ã‘ã‚‹ æ£ç›´ã€README å«ã‚ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã£ã¦ã‚ã‚“ã©ãã•ã„ã§ã™ã€‚ã—ã‹ã—ã€ã‚³ãƒ¼
mimosafa 2020/02/14
README

ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³

github

ã‚ã¨ã§èªã‚€
ãƒªãƒ³ã‚¯
è„±GitHubåˆå¿ƒè€…ã‚’ç›®æŒ‡ã™äººã®READMEãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³ä½¿ã„ã“ãªã—è¡“ | ã‚†ã£ãã‚Šã¨â€¦
README ãŒã‚ãƒãƒƒã¨æ›¸ã‹ã‚Œã¦ã„ã‚‹ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã£ã¦ã€ã©ã‚“ãªã«å°ã•ãã¦ã‚‚ç«‹æ´¾ã«è¦‹ãˆã¾ã™ã‚ˆãƒã€‚ GitHub ã®å ´åˆã€å¤§æŠµã¯ãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³è¨˜æ³•ã§æ›¸ã‹ã‚ŒãŸ README.md ã¨ã‹ README.markdown ã¨ã‹ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒã€HTML ã«å¤‰æ› ï¼ˆãƒžãƒ¼ã‚¯ã‚¢ãƒƒãƒ—ï¼‰ ã•ã‚Œã¦è¡¨ç¤ºã•ã‚Œã¦ã„ã‚‹ã“ã¨ã¯ã”å˜çŸ¥ã§ã—ã‚‡ã†ã€‚ ãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³è¨˜æ³•è‡ªä½“ã¯ã¨ã¦ã‚‚ç°¡å˜ãªã®ã§ã™ãŒã€GitHub ã§ã¯ GitHub Flavored Markdown ï¼ˆç•¥ã—ã¦ GFMï¼‰ ã¨ã„ã† GitHub ç”¨ã«ã‚¢ãƒ¬ãƒ³ã‚¸ã•ã‚ŒãŸãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³ãƒ»ã‚¨ãƒ³ã‚¸ãƒ³ãŒæŽ¡ç”¨ã•ã‚Œã¦ã„ã¦ã€ä¸€èˆ¬ã®ãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³ãƒ»ã‚¨ãƒ‡ã‚£ã‚¿ã§ãƒã‚§ãƒƒã‚¯ã—ã¦ã‹ã‚‰ã‚³ãƒŸãƒƒãƒˆã—ã¦ã‚‚ã€æ„å›³é€šã‚Šã®è¦‹ãŸç›®ã«ãªã‚‰ãªã„ã“ã¨ãŒå¤šã€…ã‚ã‚Šã¾ã™ã€‚ç§ ï¼ˆã‚‚ã¡ã‚ã‚“ GitHub åˆå¿ƒè€…ã§ã™ï¼ï¼‰ ã®å ´åˆã€README ãƒ•ã‚¡ã‚¤ãƒ«ã ã‘ã§10å›žä»¥ä¸Šã‚‚ã‚³ãƒŸãƒƒãƒˆã—ã¦ã—ã¾ã„ã¾ã—ãŸã€‚ã€Œãƒžãƒ¼ã‚¯ã‚¢ãƒƒãƒ— ï¼ˆãƒ¬ãƒ³ãƒ€ãƒªãƒ³ã‚°ï¼‰ ã‚’æ°—ã«ã—ã¦
mimosafa 2018/11/22
github

markdown

ã‚ã¨ã§èªã‚€

readme
ãƒªãƒ³ã‚¯
ã‚ã‹ã‚Šã‚„ã™ã„README.mdã‚’æ›¸ã
GitHubãªã©ã«è‡ªåˆ†ã®ãƒ„ãƒ¼ãƒ«ã‚„ãƒ©ã‚¤ãƒ–ãƒ©ãƒªã‚’å…¬é–‹ã™ã‚‹ã¨ãï¼ŒREADME.mdã¯é‡è¦ãªå½¹å‰²ã‚’æ‹…ã£ã¦ã„ã‚‹ï¼Žãƒ¬ãƒã‚¸ãƒˆãƒªã‚’è¨ªã‚ŒãŸãƒ¦ãƒ¼ã‚¶ãŒè‡ªåˆ†ã®ãƒ„ãƒ¼ãƒ«ã‚’ä½¿ã£ã¦ãã‚Œã‚‹ã‹å¦ã‹ã®ç¬¬ä¸€æ©ã¯README.mdã«ã‹ã‹ã£ã¦ã„ã‚‹ï¼Œã¨è¨€ã£ã¦ã‚‚éŽè¨€ã§ã¯ãªã„ï¼Žå®Ÿéš›è‡ªåˆ†ãŒä½¿ã†å´ã«ãªã£ãŸã¨ãã‚‚ï¼Œã¾ãšREADME.mdã‚’èªã‚“ã§åˆ¤æ–ã—ã¦ã„ã‚‹ã¨æ€ã†ï¼Ž æˆåŠŸã—ã¦ã„ã‚‹ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã‚’å‚è€ƒã«ã—ã¤ã¤ï¼Œè‡ªåˆ†ãŒå®Ÿè·µã—ã¦ã„ã‚‹ã“ã¨ã‚’ã¾ã¨ã‚ã¦ãŠãï¼Žã“ã“ã«æ›¸ã„ã¦ã„ã‚‹ã“ã¨ã¯ã‚ãã¾ã§ï¼ˆè‡ªåˆ†ã®ä¸ã§ï¼‰æœ€ä½Žé™çš„ãªã‚‚ã®ã§ã‚ã‚‹ï¼Žãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆãŒæˆé•·ã—ã¦ã„ãã«ã¤ã‚Œã¦READMEã¯ã‚ã‚‹ã¹ãå§¿ã«æˆé•·ã—ã¦ã„ãã¹ãã ã¨æ€ã†ï¼Ž READMEã®å½¹å‰² README.mdã«ã¯å¤§ãã2ã¤ã®å½¹å‰²ãŒã‚ã‚‹ï¼Ž ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆï¼Œãƒ„ãƒ¼ãƒ«ã®ä½¿ã„æ–¹ï¼Œã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«æ–¹æ³• ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆï¼Œãƒ„ãƒ¼ãƒ«ã®å®£ä¼ å…ƒã€…READMEã¯å‰è€…ã®å½¹å‰²ã—ã‹ãªã‹ã£ãŸãŒï¼ŒGitHubã®ä»•çµ„ã¿ä¸Šï¼Œå¾Œè€…ã®å½¹å‰²ã‚‚å¾ã€…ã«é‡è¦ã«ãªã£ã¦ã„ã‚‹ï¼Ž ã•ã‚‰ã«
mimosafa 2014/08/02
github

development

readme

README.md

ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆ
ãƒªãƒ³ã‚¯
1

ãŠçŸ¥ã‚‰ã›

ã‚‚ã£ã¨èªã‚€

å…¬å¼Twitter

@hatebu
æœ€æ–°ã®äººæ°—ã‚¨ãƒ³ãƒˆãƒªãƒ¼ã®é…ä¿¡

ã‚ãƒ¼ãƒœãƒ¼ãƒ‰ã‚·ãƒ§ãƒ¼ãƒˆã‚«ãƒƒãƒˆä¸€è¦§

jæ¬¡ã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

kå‰ã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

lã‚ã¨ã§èªã‚€

eã‚³ãƒ¡ãƒ³ãƒˆä¸€è¦§ã‚’é–‹ã

oãƒšãƒ¼ã‚¸ã‚’é–‹ã

è¨å®šã‚’å¤‰æ›´ã—ã¾ã—ãŸx

ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

ã‚¿ã‚°

é–¢é€£ã‚¿ã‚°ã§çµžã‚Šè¾¼ã‚€ (7)

githubã¨READMEã«é–¢ã™ã‚‹mimosafaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (3)

ãŠçŸ¥ã‚‰ã›

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬4é€±ï¼‰

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬3é€±ï¼‰

ã€å®Œäº†ã€‘ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ã®è¨ˆç”»ãƒ¡ãƒ³ãƒ†ãƒŠãƒ³ã‚¹ã®ãŠçŸ¥ã‚‰ã›ï¼ˆ2026å¹´1æœˆ23æ—¥(é‡‘) æ·±å¤œ1:30ã€œ3:00ï¼‰

å…¬å¼Twitter

ã‚ãƒ¼ãƒœãƒ¼ãƒ‰ã‚·ãƒ§ãƒ¼ãƒˆã‚«ãƒƒãƒˆä¸€è¦§

ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

å…¬å¼Twitter

ã¯ã¦ãªã®ã‚µãƒ¼ãƒ“ã‚¹

ã‚¿ã‚°

é–¢é€£ã‚¿ã‚°ã§çµžã‚Šè¾¼ã‚€ (7)

githubã¨READMEã«é–¢ã™ã‚‹mimosafaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (3)

ã‚ã‹ã‚Šã‚„ã™ã„ README é§†å‹•é–‹ç™º - Qiita

è„±GitHubåˆå¿ƒè€…ã‚’ç›®æŒ‡ã™äººã®READMEãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³ä½¿ã„ã“ãªã—è¡“ | ã‚†ã£ãã‚Šã¨â€¦

ã‚ã‹ã‚Šã‚„ã™ã„README.mdã‚’æ›¸ã

ãŠçŸ¥ã‚‰ã›

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚­ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬4é€±ï¼‰

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚­ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬3é€±ï¼‰

ã€å®Œäº†ã€‘ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ã®è¨ˆç”»ãƒ¡ãƒ³ãƒ†ãƒŠãƒ³ã‚¹ã®ãŠçŸ¥ã‚‰ã›ï¼ˆ2026å¹´1æœˆ23æ—¥(é‡‘) æ·±å¤œ1:30ã€œ3:00ï¼‰

å…¬å¼Twitter

ã‚­ãƒ¼ãƒœãƒ¼ãƒ‰ã‚·ãƒ§ãƒ¼ãƒˆã‚«ãƒƒãƒˆä¸€è¦§

ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

å…¬å¼Twitter

ã¯ã¦ãªã®ã‚µãƒ¼ãƒ“ã‚¹

é–¢é€£ã‚¿ã‚°ã§çµžã‚Šè¾¼ã‚€ (7)

githubã¨READMEã«é–¢ã™ã‚‹mimosafaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (3)

ã‚ã‹ã‚Šã‚„ã™ã„ README é§†å‹•é–‹ç™º - Qiita

è„±GitHubåˆå¿ƒè€…ã‚’ç›®æŒ‡ã™äººã®READMEãƒžãƒ¼ã‚¯ãƒ€ã‚¦ãƒ³ä½¿ã„ã“ãªã—è¡“ | ã‚†ã£ãã‚Šã¨â€¦

ã‚ã‹ã‚Šã‚„ã™ã„README.mdã‚’æ›¸ã

ãŠçŸ¥ã‚‰ã›

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬4é€±ï¼‰

ä»Šé€±ã®ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯æ•°ãƒ©ãƒ³ã‚ãƒ³ã‚°ï¼ˆ2026å¹´1æœˆç¬¬3é€±ï¼‰

ã€å®Œäº†ã€‘ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ã®è¨ˆç”»ãƒ¡ãƒ³ãƒ†ãƒŠãƒ³ã‚¹ã®ãŠçŸ¥ã‚‰ã›ï¼ˆ2026å¹´1æœˆ23æ—¥(é‡‘) æ·±å¤œ1:30ã€œ3:00ï¼‰

å…¬å¼Twitter

ã‚ãƒ¼ãƒœãƒ¼ãƒ‰ã‚·ãƒ§ãƒ¼ãƒˆã‚«ãƒƒãƒˆä¸€è¦§

ã¯ã¦ãªãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

å…¬å¼Twitter

ã¯ã¦ãªã®ã‚µãƒ¼ãƒ“ã‚¹