환승시민 프로젝트의 대망의 장식 Read.me 작성하기

김재우·2022년 12월 14일
0

TIL

목록 보기
16/17
post-thumbnail

Read.me 를 잊고 있었다.
열심히 달려온 6주간 정말 프로젝트다.

마지막으로 우리 프로젝트를 더욱 빛낼 방법은 우리 프로젝트를 누군가에게 가시성 좋게
나타내고 설명해주는것이다.

그렇게 하기 위해서는 꼭 Readme 파일이 필요한데.

말 그대로 프로젝트 소개 , 개요 등등을 적어서 다른 제 3자가 우리 프로젝트에 대해서 파악을 할때 도움을 줄 수 있는 파일이다.

나는 일단 리드미 파일을 작성한적이 없어 다른 조와 전 기수 사람들의 리드미를 보고 목차를 나눠봤다.

  1. 프로젝트
  2. 프로젝트 소개
  3. 프로젝트 아키텍쳐
  4. 기술스택
  5. 기술스택 & 라이브러리 사용 이유
    주요 기능
    트러블 슈팅
    환승시민 팀원들

다른 조원들의 리드미를 참조하여 작성을 해봤다. 6주간 열심히 진행했던 프로젝트이다 보니
또 다른 제 3자가 봤을때 마음에 들었으면 하는 마음에 열심히 꾸며보기로 했다.

환승시민의 리드미 파일 작성GIF

profile
프론트엔드 꾸준개발자입니다.

0개의 댓글