[항해99 취업 리부트 코스 학습일지] README.md는 금싸라기땅! 💰

 

이번 주 목표

토비의 스프링 부트 공부

GO API 1개 만들기

오늘 목표

토비의 스프링 부트 공부

항해 오프라인 세션

오늘 한 것

 

오늘 스케줄

6:00 기상 산책

7:00 식사 샤워

8:00 GO 프로젝트

10:30 항해 99 취업코스

7:00 항해 종료

 

1. README.md는 금싸라기땅!!!

 

1) 핵심 기능

7줄

 

2) 인프라, 배포 환경 이미지 

3) CI/CD flow 이미지

 

4) 사전 요구사항

 

5) 설치 방법

npm install

npm run start

자바는 docker run~ (한 번에 실행되게)

 

6) 우리의 TS

 

7) 문제 해결 방법

만약에 문제를 발견하셨다면 이슈를 남겨 주시면 검토하겠습니다. 

License MIT

 

8) 변경 로그의 링크

 

 

 

README.md의 위치

= 루트 디렉토리 

= README.md

 

마크다운 형식

 

H1 # 문서 하나에 하나
H2 ##
H3 ###
H4 ####
H5 #####

 

_이탤릭체_

 

리드미를 잘 써야 하는 이유

1. 프로젝트 이해 촉진
2. 협업 능력 강조
3. 기술 스택 및 도구 사용 설명
4. 문서화 및 소통 능력 강조
5. 포트폴리오 강화 

 

 

Dont’s & Tips

 

텅 빈 리드미 = 예의 상실

 

TMI = 전략적으로 필요한 것들만 잘 배치

> 중요하지 않은 것은 링크로 빼기

 

너무 많은 강조 

볼드 처리는 하나만

 

너무 예쁜 걸로 도배하면

난잡해 보이고 시선이 분산된다

절제하면서 진짜 보여주고 싶은 내용을 예쁘게

 

커밋 컨벤션은 넣지 말자

깃꾸 많이 하는 것은 크게 관계없다

한국어로 적어도 좋다

 

Directory Structure은 금싸라기 땅에 들어가기에 아깝다

 

사용자 피드백은 높은 우선순위가 아니다

 

env는 제공해야 한다

규모에 맞지 않지만 해보고 싶었다는 것을 꼭 명시

makefile 쉘스크립트 - 명령어

잘 패키징이 되고 한 번에 프로젝트를 보여줄 수 있게 준비

 

 

---

정리 

README.md

1) 핵심 기능

7줄

 

2) 인프라, 배포 환경 이미지 

3) CI/CD flow 이미지

 

4) 사전 요구사항

 

5) 설치 방법

npm install

npm run start

자바는 docker run~ (한 번에 실행되게)

 

6) 우리의 TS

 

7) 문제 해결 방법

만약에 문제를 발견하셨다면 이슈를 남겨 주시면 검토하겠습니다. 

License MIT

 

8) 변경 로그의 링크

 

KPT

Keep

열심히 하려고 하는 것, 분석적 사고를 잡아가는 것, 조사하는 습관을 들인 것

Problem

잠이 많다....

Try

잠죽자

소감

잠죽자

 

항해99 취업 리부트 코스를 수강하고 작성한 콘텐츠 입니다.

IT 커리어 성장 코스 항해99, 개발자 취업부터 현직자 코스까지