Github README를 꾸며보자!

개요

안녕하세요. 최근 이직 준비를 시작하면서 개발자 이력서는 어떻게 작성해야하는가? 에 대해서 정말 고민이 많았습니다. 그러던 중 유튜브나 구글링을 통해서 많은 이력서를 참고하게 되었어요. 요즘 개발자들한테는 블로그, github링크는 기본으로 이력서에 표기한다는 말이 정말 많았고, 저도 이에 참여하고자 github링크를 공개하기로 맘먹었습니다. 하지만 github 초기 페이지가 너무 심심해 보여서 어떻게 어필하면 좋을 지 고민하다 github README 페이지를 꾸며보았습니다!

 

Github README 만들기

나의 README 소개

저는 예시를 보여주고자 미리 README파일을 만들어봤습니다! 이번 글에서는 TechSkill 이모티콘으로 표기하기, GithubStats, BaekJoon을 표기하는지 README파일에 넣으면 좋을 것 같은 내용 등등 소개해드리도록 하겠습니다!

 

https://github.com/cyeji/Cyeji

GitHub - cyeji/Cyeji: Config files for my GitHub profile.

글 보러 오신김에...위에 링크 타고 가셔서 Star 한번씩 눌러주시면 감사하겠습니다 🥰

 

Github profile에 표기될 README.md파일 생성하기

우선 Repositories 탭에서 New 버튼을 클릭하셔서 새로운 프로젝트를 생성합니다.

1. Repository name은 자신의 계정명 제 계정아이디는 cyeji여서 cyeji로 레포명을 작성해줬습니다.

(저는 이미 만들어서 아래와 같은 경고창이 뜨는 것이니 신경안쓰셔도 됩니다.)

2. repository는 Public으로

3. Add a README file 클릭 후 Create repository 선택

 

위의 작업을 완료하시면 main profile에 README파일이 생성될 것입니다!

https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme

Managing your profile README - GitHub Docs

 

Header 만들기

https://github.com/kyechan99/capsule-render

GitHub - kyechan99/capsule-render: 🌈 Dynamic Coloful Image Render

<img src="https://capsule-render.vercel.app/api?type=wave&color=auto&height=300&section=header&text=capsule%20render&fontSize=90" />

 

TechSKill 작성하기

저는  백엔드 개발자이지만 필요에 따라 프론트 개발도 겸하고 있습니다. 그래서 Spring, Vue.js, jQuery등을 사용해보았고, 이를 기술스택으로 표기하였습니다.

제가 작성한 기술스택 별 코드 입니다. 혹시 같은 기술을 사용하고 계신다면, 제 코드를 삽입하셔도 좋을 것 같아요 :)

 

<H3> TechSkill </H3>
<div>
  <img src="https://img.shields.io/badge/Spring-6DB33F?style=for-the-badge&logo=Spring&logoColor=white">
 <img src="https://img.shields.io/badge/postgresql-4169E1?style=for-the-badge&logo=postgresql&logoColor=white">
 <img src="https://img.shields.io/badge/microsoftsqlserver-CC2927?style=for-the-badge&logo=microsoftsqlserver&logoColor=white">
 <img src="https://img.shields.io/badge/JAVA-red?style=for-the-badge&logo=OpenJDK&logoColor=white">
 <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=white">
 <img src="https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white">
 <img src="https://img.shields.io/badge/jquery-0769AD?style=for-the-badge&logo=jquery&logoColor=white">
 <img src="https://img.shields.io/badge/vue.js-4FC08D?style=for-the-badge&logo=vuedotjs&logoColor=white">
 </div>

이 외에 다른 기술스택을 사용하시는 분들을 아래 참고하시면 됩니다 :)

 

아이콘내용-바탕색, 로고이름은 본인이 원하는 기술스택을 찾아서 변경하면 됩니다.

<img src="https://img.shields.io/badge/아이콘내용-바탕색?style=flat&logo=로고이름&logoColor=white"/>

로고찾기

https://simpleicons.org/

Simple Icons

 



GithubState 표기하기

 

https://github.com/anuraghazra/github-readme-stats

GitHub - anuraghazra/github-readme-stats: Dynamically generated stats for your github readmes

<img src="https://github-readme-stats.vercel.app/api/top-langs/?username=본인github아이디&layout=compact"><br><br>
<img src="https://github-readme-stats.vercel.app/api?username=본인github아이디&show_icons=true">

 

백준 티어 표기하기

https://github.com/mazassumnida/mazassumnida

GitHub - mazassumnida/mazassumnida: Github 프로필에서 boj 프로필을 이쁘게 보여주는 프로젝트

[![Solved.ac 프로필](http://mazassumnida.wtf/api/generate_badge?boj={본인백준아이디})](https://solved.ac/{백준_아이디})

저는 백준 티어 프로필 표기외에도 어떤 스터디에서 알고리즘 공부를 하고 있는지 부가 설명과 링크를 적어놨습니다 :) 아직 작고 귀여운 실버지만 '알고리즘까지 브론즈가 될 순 없어'라는 스터디를 만들어 다같이 원하는 티어까지 올리기 위해 열심히 풀고 있습니다 

https://github.com/algorithm-cote-study/baekjoon-algorithm

GitHub - algorithm-cote-study/baekjoon-algorithm: 알고리즘까지 브론즈가 될 수 없어

 

이 외에 표기하는 것

제가 표기해놓은 것외에도 다른 사람들이 많이 표기해놓은 것들을 정리해보았습니다.

 

방문자수

https://hits.seeyoufarm.com/

HITS

 

백준 잔디 표기하기

https://github.com/mazassumnida/mazandi

GitHub - mazassumnida/mazandi: ✅ solved.ac 잔디를 예쁘게 보여주는 프로필 카드 API

<img src="http://mazandi.herokuapp.com/api?handle={handle}&theme=warm"/>

 

참고하면 좋은 글

1년전에 나온 영상이지만 드림코딩에서도 깃허브 계정 제대로 꾸미기라는 영상을 올리셨네요 저도 얼마전에 알았습니다 ㅎㅎ

이영상에서는 제가 추가한 내용 외에도 오픈소스, 내가 자주 사용하는 언어를 이용해 나를 표현하기 등 다양한 방법으로 README파일을 작성해놓은 글을 볼 수 있습니다. 시청해보시는 것을 추천드려요~!

 

https://www.youtube.com/watch?v=w9DfC2BHGPA&t=158s 

https://github.com/abhisheknaiidu/awesome-github-profile-readme

GitHub - abhisheknaiidu/awesome-github-profile-readme: 😎 A curated list of awesome GitHub Profile READMEs 📝

 

마지막으로

제 글이 도움이 되셨다면 star 한번 씩만 눌러주세요 .... 🥰🥰🥰

 

https://github.com/cyeji/Cyeji

GitHub - cyeji/Cyeji: Config files for my GitHub profile.

 

모르시거나 궁금한 것, 잘못된 부분은 언제든지 댓글로 남겨주세요 :)