<aside> 🤔 들어가기 전에, Readme 왜 작성해야 하나요?

</aside>

1. README가 없는 프로젝트

2)README가 상세한 프로젝트

여러분은 최종프로젝트를 이력서에 기재하셨고, 면접관은 이 프로젝트가 흥미롭다고 생각하여 GitHub에 들어가봅니다. 이때 README가 텅 비어있다면 어떻게 될까요?, 여러분들은 README가 없는 프로젝트를 보실때 어떤 기분이 드시나요?

README는 레포지토리를 방문한 사람에게 “이 프로젝트는 무엇인지” 를 알기 쉽게 전달해주는 중요한 역할을 합니다.

내 프로젝트에 흥미를 가질 수 있는지, 내 프로젝트를 써줄지에 대한 부분은 사실상 README가 결정한다고 해도 과언이 아닙니다.

<aside> ❓ README 어떻게 작성할까

</aside>

• README는 한 번에 다 적는 것이 아닌, 프로젝트 수행하며 조금씩 추가해야 하는 것이다.

  • 한 가지 기능을 완성했다면 바로 README 작성해주세요

• 간결하고, 알기 쉽게 작성해야 한다.

  • 처음 레포지토리 방문한 유저가 쉽게 알 수 있게 가독성을 생각할 것

• 적당한 개행과 불렛포인트 사용

  • Markdown 문법을 사용

  • Markdown Editer를 사용해서 먼저 마크다운 문법에 익숙해지는 것도 좋습니다.

  • 개발 블로그로 많이 사용되는 Velog도 마크다운 문법을 사용한다는 사실!

    StackEdit

• 이미지, 스택 뱃지 등 비주얼적인 요소 추가하기

  • 처음 읽는 입장에서 흥미가 생길 수 있고 한 눈에 큰 정보를 볼 수 있게 할 것

<aside> ⏳ 어떤 내용을 작성하는게 좋을까요?

</aside>

• 무엇을 위한 것인가
• 이 프로젝트를 만들며 어떤 기술적 의사결정을 했는가
• 어떻게 작동하는가
• 이 프로젝트를 하며 어떤 트러블이 있었고 트러블 슈팅은 어떻게 진행했는가
• 이 프로젝트를 누구와 함께 만들었는가
• 참고