개발일기/개발일지

GitHub ReadMe.md 작성하기

라미보 2023. 1. 3. 14:29

 

 

1. GitHub에 Repogitory를 생성한다! 이때, README.md 추가해서 같이 생성하기

2. README.md에 내용 입력하기

  • 제목
  • 개발한 사이트 화면 이미지(있으면 더 좋을거 같다!)
  • Demo 링크 (이게 중요하다고 생각함) - 어떤 사이트를 참고했는지
  • 개발목표
  • 사용기술
  • Advaced Feature - 내가 자랑하고 싶은 기능, 강조하고 싶은기능, 이미지나 소스코드
  • 개선사항(후기) - 프로젝트를 하면서 부족한 점이나 배운점

 

 

 

 

 

✨ 저의 첫번째 팀프로젝트 입니다!

✨ Github: https://github.com/ramivo08/How-about-this-car.git

 

GitHub - ramivo08/How-about-this-car: 🚗이차어때 : 팀프로젝트로 진행된 중고차 매매 사이트 개발

🚗이차어때 : 팀프로젝트로 진행된 중고차 매매 사이트 개발. Contribute to ramivo08/How-about-this-car development by creating an account on GitHub.

github.com

 

 

 

 

 

취업을 준비하면서 이력서와 자기소개서를 작성하면서 github 주소를 이력서에 첨부하면서

 

나의 github를 다른 사람들이 보기 편하게 만들어야겠다는 생각으로 ReadMe.md를 작성해보았습니다.

 

작성하면서 지난 프로젝트를 어떻게 했는지 다시 상기해보는 시간을 가져볼 수 있었습니다.

 

 

 

 

아래의 블로그를 참고하여 작성 해보았습니다.

 

https://cordingdiary.tistory.com/88

 

[프로보노 프로젝트] GitHub README.md 작성

내가 맡은 부분(전처리와 엔진)은 90%정도 개발이 완료되어 깃허브에 COMMIT을 해두었다. 우리의 프로젝트를 모르는 사람도 잘 이해할 수 있게 README도 작성하고싶은데 어떤 내용이 들어가면 좋을

cordingdiary.tistory.com

 

 

 

 

 

작성된 내용은 아래의 동영상을 보고 도움을 얻었습니다.

 

https://www.youtube.com/watch?v=5UIZ_WYwCfI