Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
GitHub の README をいい感じにする / Cool Readme
Search
Taiju Aoki
November 08, 2019
Programming
3
1.7k
GitHub の README をいい感じにする / Cool Readme
LT for M3 TechTalk
Taiju Aoki
November 08, 2019
Tweet
Share
More Decks by Taiju Aoki
See All by Taiju Aoki
本番運用中 Oracle を破壊してしまった話 ~ 破壊と創世 ~ / Oracle Destruction and Creation
blue0513
0
3k
オンプレ to オンプレした話/on-premises2on-premises
blue0513
0
3k
GitもCIもテストもないプロジェクトでデプロイを自動化するまでの道 / rebuild of DevOps
blue0513
0
3.2k
Git & GitLab & コードレビューって? / about Git, GitLab, CodeReview
blue0513
0
230
ElectronでSlackをさらに便利にしちゃう / Slack with Electron
blue0513
3
850
Emacs × Sound やってみた / Emacs with Sound
blue0513
1
1k
Slack を TweetDeck にしてみた件 / slackdeck-proto
blue0513
0
2.9k
知ってるとお得な iTerm2 と zsh/bash の小技
blue0513
3
840
クラウド電子カルテを支える魂の技術
blue0513
0
2.4k
Other Decks in Programming
See All in Programming
SwiftでMCPサーバーを作ろう!
giginet
PRO
2
190
AWS Summit Japan 2024と2025の比較/はじめてのKiro、今あなたは岐路に立つ
satoshi256kbyte
1
250
What's new in AppKit on macOS 26
1024jp
0
170
変化を楽しむエンジニアリング ~ いままでとこれから ~
murajun1978
0
140
ソフトウェア設計とAI技術の活用
masuda220
PRO
25
6.7k
Rails Frontend Evolution: It Was a Setup All Along
skryukov
0
320
GPUを計算資源として使おう!
primenumber
1
290
20250708_JAWS_opscdk
takuyay0ne
2
150
[DevinMeetupTokyo2025] コード書かせないDevinの使い方
takumiyoshikawa
2
170
可変性を制する設計: 構造と振る舞いから考える概念モデリングとその実装
a_suenami
3
590
Gemini CLIの"強み"を知る! Gemini CLIとClaude Codeを比較してみた!
kotahisafuru
2
160
ISUCON研修おかわり会 講義スライド
arfes0e2b3c
1
480
Featured
See All Featured
Rebuilding a faster, lazier Slack
samanthasiow
83
9.1k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
45
7.5k
The Language of Interfaces
destraynor
158
25k
Embracing the Ebb and Flow
colly
86
4.8k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
21
1.3k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
48
2.9k
How STYLIGHT went responsive
nonsquared
100
5.6k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
34
3.1k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
44
2.4k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
26k
Designing for humans not robots
tammielis
253
25k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
194
16k
Transcript
GitHub ͷ README Λ͍͍ײ͡ʹ͢Δ @blue_1617
ࢲ୭ʁ blue (@blue_1617) https://blue0513.github.io/show_room/ 2 ‣ ΤϜεϦʔגࣜձࣾ ιϑτΣΞΤϯδχΞ ‣ Emacs,
Ruby, JavaScript ‣ VisualStudio, C# ‣ ےτϨΛ࠷ۙ͡Ίͨ ‣ ମॏ͕4Ωϩۙ͘૿͑ɺՌΛײ͍ͯ͡Δ ‣ ࠓظΦεεϝΞχϝ ‣ ΞϑϦΧͷαϥϦʔϚϯ
GitHub ͷ README Λ͍͍ײ͡ʹ͢Δ
ࠓճͷΰʔϧʂʂ 4
ࠓճͷΰʔϧʂʂ 5 ͳΜ͔ͭ·ΒΜͳ......
ࠓճͷΰʔϧʂʂ 6
ࠓճͷΰʔϧʂʂ 7 ͔͍͍ͬ͜ʂʂʂ
ࠓճͷΰʔϧʂʂ 8 https://github.com/blue0513/slackdeck-proto Project Name, Release Version, DL, ESLint, Jest
Λදࣔͨ͠ Badge Λ README ʹ͚ͭΔ
ඞཁͳཁૉͨͪ 9 README ΛؚΜͩΞϓϦέʔγϣϯ
10 ඞཁͳཁૉͨͪ GitHub
11 ඞཁͳཁૉͨͪ ESLint
12 ඞཁͳཁૉͨͪ Jest
13 ඞཁͳཁૉͨͪ Badge
14 ඞཁͳཁૉͨͪ Badge Jest ESLint GitHub
15 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
README ΛؚΜͩΞϓϦέʔγϣϯ 16 Slack Λ TweetDeck ෩ʹݟΔπʔϧ https://github.com/blue0513/slackdeck-proto
README ΛؚΜͩΞϓϦέʔγϣϯ 17 Slack Λ TweetDeck ෩ʹݟΔπʔϧ https://github.com/blue0513/slackdeck-proto
18 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
19 GitHub Actions https://github.com/features/actions
https://github.com/features/actions GitHub Actions 20 https://github.com/features/actions ৄࡉެࣜΛݟͯ͘Ε͍͞ʂ ‣ CircleCI Travis
ΛΘͣʹ CI/CD Ͱ͖Δػೳ ‣ Linux, Windows, macOS ʹରԠ ‣ 3rd party ͷ Action Λར༻Մೳ ‣ yml Ͱ Workflow ΛఆٛՄೳ ‣ Public Repo: Free! ‣ Private Repo: ैྔ՝ۚੑ
21 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 22 $ touch REPOSITORY/.github/workflows/eslint.yml $ emacs
-nw eslint.yml $ git add --all & git commit -m "add eslint" $ git push yml ΛσΟϨΫτϦʹՃͯ͠ push ͢Δ
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 23 push ࣌ʹಈ͘ ubuntu Ͱಈ͘ root
directory ESLint !
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 24 Actions λϒͰ ESLint ͕࣮ߦ͞ΕΔ
25 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 26 $ touch REPOSITORY/.github/workflows/jest.yml $ emacs
-nw jest.yml $ git add --all & git commit -m "add jest" $ git push yml ΛσΟϨΫτϦʹՃͯ͠ push ͢Δ
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 27 push ࣌ʹಈ͘ ubuntu Ͱ࣮ߦ Node
͕ೖΔ Jest !!
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 28 Actions λϒͰ Jest ͕࣮ߦ͞ΕΔ
29 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
README ʹ Badge ΛՃͯ͠Έͨ 30 GitHub ͷ README ͰΑ͘ݟΔ͍ͭ͜ΒΛ......
README ʹ Badge ΛՃͯ͠Έͨ 31 GitHub ͷ README ͰΑ͘ݟΔ͍ͭ͜ΒΛՃ͢Δ
README ʹ Badge ΛՃͯ͠Έͨ 32 https://shields.io/ shileds.io Λͬͯ Badge Λ࡞Δ
README ʹ Badge ΛՃͯ͠Έͨ 33 https://shields.io/ shileds.io Λͬͯ Badge Λ࡞Δ
README ʹ Badge ΛՃͯ͠Έͨ 34 ྫ͑ɺBuild ؔ࿈ͷ Badge ͨ͘͞Μ͋Δ
README ʹ Badge ΛՃͯ͠Έͨ 35 Markdown ʹຒΊࠐΉ߹ɺLink Λॻ͚Α͍  Custom
Badge  Release Version /github/v/release/:user/:repo /travis/:user/:repo , etc ...
README ʹ Badge ΛՃͯ͠Έͨ 36 GitHub Actions ͷ߹ɺshields.io ΛΘ͍͚ͣΔ 
Jest  ESLint https://github.com/{owner}/{repo}/workflows/{workflow_name}/badge.svg)
ͱ͍͏Θ͚Ͱɺ৭ʑ͚ͬͨͲ.....
None
None
None
ࠓճͷΰʔϧʂʂ 41 https://github.com/blue0513/slackdeck-proto Project Name, Release Version, DL, ESLint, Jest
Λදࣔͨ͠ Badge ͕ README ʹ͍ͭͨʂ
·ͱΊ 42 ‣ GitHub Actions Ͱ CI/CD ΛճͤΔΑ͏ʹͳͬͨ ‣ yml
ఆٛʹΑͬͯ ESLint, Jest ͳͲ͕࣮ߦ ‣ Public Repository ແྉ ‣ Shields.io Ͱ Badge Λ࡞Ͱ͖ΔΑ͏ʹͳͬͨ ‣ Repository ͷ༰ΛಡΈऔͬͯࣗಈ࡞ ‣ Custom Badge ͰΦϦδφϧײग़ͤΔ ‣ README ͕ͦΕͬΆ͘ͳͬͨʂ