README 꾸미기

Github 프로필 화면을 꾸며보자.

 

README 생성

1. GitHub에서 저장소 생성화면까지 가자

2. repository name을 내 닉네임과 똑같이

3. Public 체크

4. Add a README file 체크

5. Create repository 버튼 클릭

🐹 이렇게 하면 기존과 같이 저장소가 생성이 되고 readme 내용이 프로필 메인에 보이게 된다 

6. 생성한 저장소를 로컬로 clone

 

GitHub Action

readme 꾸미기에 앞서 알아야할 것!

GitHub Action에 대해 알면 진행하는데에 시간을 아낄 수 있을 거라 생각된다. 

아래 페이지의 내용만 보아도 이렇게 흘러가는구나를 알 수 있다.

https://docs.github.com/en/actions/about-github-actions/understanding-github-actions

Understanding GitHub Actions - GitHub Docs

https://docs.github.com/en/actions/writing-workflows/quickstart

Quickstart for GitHub Actions - GitHub Docs

 

 

README 꾸미기

처음엔 어떻게 꾸밀지 고민하면서 구글링 해보니 다양한 템플릿을 제공해주는 오픈소스를 찾았다.!

https://github.com/rzashakeri/beautify-github-profile?tab=readme-ov-file

GitHub - rzashakeri/beautify-github-profile: This repository will assist you in creating a more beautiful and appealing github p

 

---

 

wakaTime

1. README에 wakaTime을 보여줄 자리 만들기. 

  START와 END 사이에 보여진다.

 <!--START_SECTION:waka-->
 <!--END_SECTION:waka-->

2. https://wakatime.com/

  로그인 하여 API Key 받아두기

3. 내 저장소의 Settings - secrets and variables - Actions - Repository secrets - New Repository Secret

Name -> WAKATIME_API_KEY
Value -> 생성한 wakaTime API Key

4. 내 저장소의 Actions - set up a workflow yourself(New Workflow)

  1) .yml 파일명 지정

  2) yml 내용 작성

name: Waka Readme  # Acions 이름

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'
  workflow_dispatch:
  
  permissions: # GitHub default token의 읽기 쓰기 권한 허용
    contents: write

jobs:
  update-readme:
    name: Update Readme with Metrics
    runs-on: ubuntu-latest
    steps:
      - uses: anmol098/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }} # settings에서 만든 secret name
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub default token

이렇게 생성한 workflow는 Actions 메뉴 좌측에 보이게 된다.

5. 생성한 workflow인 'Waka Readme' 클릭 - Run workflow 클릭

  readme를 업데이트 하기 시작하여 약 2분 뒤 반영된다.

 

Latest Blog Post