-Today's Learning Content-

  • README 작성

1. 프로젝트 README 작성

구현 과제

프로젝트를 소개하는 README를 예쁘게 만들기

1) README 작성하기

오늘은 프로젝트가 거의 완성된 김에 깃허브에 올린 README 파일을 수정하기로 했다.
기존의 README 파일은 너무 어지럽고 정리가 안 된 느낌이었기 때문에 사진도 넣고... 프로젝트에 대한 설명도 추가해서 더 예쁘게 만들고자 했다.
그리고 메인 이미지를 만들고 싶어서 고민을 해보았는데, 우리 프로젝트의 포인트 중 하나인 다크모드, 라이트모드를 지원한다는 점을 강조하고 싶었다.
그래서 아래와 같은 메인 이미지를 만들었다.

중간에 튜터님도 보시고 예쁘다고 감탄하고 가셨다
그 뒤로는 프로젝트명, 기간, 목표 등 프로젝트와 관련된 사항들을 추가하고 브랜치 전략, 커밋 컨벤션 등 프로젝트를 진행하며 정했던 규칙 등에 대해 정리하여 README에 작성하였다.

README가 궁금하다면 이쪽으로...

사실 프로젝트에서도 코드와 관련된 여러 이슈도 겪고 수정도 진행했지만...
너무 많은 내용이기도 하고 프로젝트를 만드느라 시간이 없어서 오늘의 블로그는 이 정도로 끝낸다.

-Today's Lesson Review-

README를 이쁘게 꾸몄다고 칭찬을 들어서 기분 좋은 하루였다.
profile
이유있는 코드를 쓰자!!

1개의 댓글

comment-user-thumbnail
2024년 11월 28일

🧎‍♂️‍➡️ 절 하는 중 ,,, 체고 마빈

답글 달기