인프런 커뮤니티 질문&답변
작성한 질문수
Readme 파일 작성방법
해결된 질문
작성
·
212
1
안녕하세요 강사님 좋은 강의 감사드립니다.
readme파일을 잘 작성하는 것도 과제전형을 진행하는데 중요한 요소라고 들었는데
예제 소스에 작성된 readme 파일 형식으로 실제 과제전형 시에 제출하기에는 조금 부족해보이는데
보통 어떤 형식으로 작성하시는 편이신가요? 또는 이 부분은 꼭 들어갔으면 하는 요소가 있을까요?
답변 1
2
J Tech
지식공유자
안녕하세요 걈쟈님~ 질문 남겨주셔서 감사합니다 ☺
README 파일 은 프로젝트가 무엇을 하는지, 어떻게 사용할 수 있는지, 그리고 필요한 설정이나 설치 방법 등을 빠르게 이해할 수 있도록 적는것이 좋습니다.
과제제출시 명확한 README 요구사항이 없다면 임의로 작성하셔도 무방합니다. 다만 시스템구조 도식이 들어가면 더 좋을듯합니다. README 작성법에 대한 내용을 조금 더 보강하여 섹션5. 면접대비 - 작업검토 강의의 수업노트에 올려두었으니 참고부탁드립니다. 추가적인 질문이 있다면 편하게 남겨주세요 🙏
빠르게 답변주셔서 감사합니다~!! 보강해주신 내용 도움이 많이 되었습니다 감사합니다 :)