TIL 90 - [ Spring 최종 프로젝트 ( Day 26 ) - 5분 브리핑 [2회차], ReadMe 작성 ]

📣 5분 브리핑 [ 2회차 ]

5분 브리핑 [ 2회차 ] | Notion

완성된 발표 자료 본으로 녹화를 해서 제출 하였다. 

 

1회차때에 고도화 다룰 기능을 다뤄야 했었는데 생각보다 짧은 프로젝트 기간에 많은 기능을 구현해보는 것이 쉽지 않았다. 발표 때 에는 주로 그 기간동안 리팩토링한 과정과 고도화 기능에 대해서 주로 브리핑하고 테스트 코드는 언급 정도만 하였다. 

 

📃 ReadMe 작성

README.md는 개발자가 만든 프로젝트에 대해 다른 사람들에게 쉽게 소개하고 이해할 수 있도록 도와주는 설명서 같은 역할을 합니다. 주로 GitHub 같은 버전 관리 플랫폼에 업로드된 프로젝트에서 사용된다.

🧾 README란?

• "Read Me!" (이걸 먼저 읽어보세요!)라는 뜻이다.
• 프로젝트의 목적, 사용 방법, 설치 방법, 기여 방법 등을 한눈에 볼 수 있게 정리한 파일
• 형식은 마크다운(Markdown) 문법으로 작성되어 있고, 보통 README.md 라는 이름을 가진다.

이런식으로 정리 하였다. ReadMe는 가장 먼저 노출이 되는 곳으로 해당 프로젝트가 어떤 목적이고, 어떤 기술 스택을 썻고, 어떤 기능이 있는지 등등 설명을 하는 가장 첫번째로 보는 설명서 같은 역할이다. 

그래서 이것에 대해 참고를 해서 작성하였다. ( 조금더 추가 될 부분들이 있어서 병합은 나중에 할 예정이다. )