우리가 프로그램을 제공할때 사용설명서(README.md)를 제공하는 것 처럼 github에도 우리의 레포지토리를 위한 README.md를 설정할 수 있습니다.
다음은 github-readme-stats 플러그인을 만든 사람의 깃헙입니다. 자신의 깃헙에도 플러그인을 설정해두었네요.
우리도 이 플러그인을 설정하면 아래와 같은 깃헙 첫화면을 갖게 됩니다.
여러가지 색상중에 하나의 테마를 제가 고를수는 있습니다.
하지만, 아쉽게도 아직은 다크모드와 라이트모드에 따라 자동으로 바뀌는 스킨은 없습니다.
다음은 보라색으로 스킨을 설정했을때 다크모드와 라이트모드에서 어떻게 보이는지에 대한 캡쳐화면입니다.
아래의 같이 저장소를 먼저 둘러보시기를 추천 드립니다. 각 저장소마다 Readme가 있고, 따라 읽어보면, 설치할 수 있게 되어 있습니다.
한국어 저장소도 있습니다.
하지만, 전체적인 관점에서는 누락된 부분들이 있어 아래에서 제가 자세히 설명하고자 합니다.
github.com/anuraghazra/github-readme-stats
github.com/anuraghazra/github-readme-stats/blob/master/docs/readme_kr.md
아래의 Repository name 에 왼쪽의 Owner 필드에 있는 내 아이디를 넣어줍니다.
이것은 깃헙에서 제공하는 특별한 저장소로, 저의 깃헙 프로필 전체에 대한 Readme를 저장하는 레포지토리를 만드는 과정입니다.
아랫쪽에 있는 체크 박스 중 [Add a README file]를 체크 해줍니다.
아래와 같이 깃헙 첫화면에 리드미가 표시됩니다.
아래와 같이 깃헙의 첫 화면에서 해당 플러그인 우측 상단의 연필모양을 눌러줍니다. 그림의 오른쪽 위에 보면, 고양이 밑에, send feedback 글자가 보이고 그 옆에 연필모양이 있는것이 보입니다.
아래는 리드미의 소스코드 입니다. 원하는 위치에 아래의 소스코드를 붙여넣어줍니다.
특별히 주의해야 할 부분은 ?username=xxxxx) 부분에서 xxxxx부분을 내 아이디로 바꿔주어야 한다는 것입니다.
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
첫화면으로 다시 가보면, Stats플러그인이 잘 설치되어 있는것을 확인할 수 있습니다.
해결법: 기존 코드에서 일부 파라미터를 제거해 주셔야 합니다.
기존코드(original code)
[![Peter's GitHub stats](https://github-readme-stats.vercel.app/api?username=peter&count_private=true&include_all_commits=true&show_icons=true&hide=issues)]()
오류를 발생시키는 부분(issue that need to be deleted)
&count_private=true&include_all_commits=true&show_icons=true&hide=issues
최종코드(final code to fix)
[![Peter's GitHub stats](https://github-readme-stats.vercel.app/api?username=peter)]()
위에서 해준것과 같이 ?username=xxxx)부분의 아이디를 나의 아이디로 수정하고 저장하시면 바로 화면에 표시됩니다.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
해결법: 기존 코드에서 일부 파라미터를 제거해 주셔야 합니다.
기존코드
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=Peter&hide=html&langs_count=10&layout=compact)]()
오류를 발생시키는 부분
&hide=html
최종코드
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=peter&langs_count=10&layout=compact)]()
위와 같이, 간단히 리드미에 통계를 보여줄 수 있는 플러그인 설정을 완료 하였습니다.
아래의 글도 한번 읽어보세요.