보통 github의 readme에 무엇무엇을 적으시나요?

Question

안녕하세요. github에 소스를 올려놓고 다른 오픈소스를 탐험(?)해보니 대부분 readme를 되게 상세히 적어놓길래 제가 올린 프로젝트도 readme를 좀 상세히 적어보려고 합니다. 일단 생각해둔 목차는1. 프로젝트 요약(프로젝트의 목적이나 참여인원, 내가 맡은 부분 등)2. 개발환경3. 주요기능4. ?... 정도인데 오픈소스를 여러개 살펴보면 저정도 들어가면 될 듯한데 어떤가요?무조건 꼭 들어가야한다? 이런 목차가 있을까요? 프로젝트 수준은 학부생 공모전이나 팀프로젝트 수준입니다.

최첨단 · Accepted Answer

기능, 실행방법, 간단한 사용 방법, 라이센스만 남기세요. 1분 안에 다 읽을 수 있을정도로... 더 자세한거는 별도 문서 디렉토리나 사이트를 만드시고요.아래 readme 참고 하세요.https://github.com/JakeWharton/butterknife/blob/master/README.md

Mambo · Answer

작성하시면 깃허브주소좀 알려주세요 저도 참고하고 싶습니다!

10년~ · Answer

보통 프로젝트 자랑이죠 ㅎㅎ

EastGlow · Answer

KDEV 어후 저보다 훨씬 잘 꾸며두셨던데...ㄷㄷ10년~ ㅎㅎ... 신입 지원 시에 보일 용도라서 좀 상세히 적어야겠네요.최첨단 감사합니다. 제가 지금 써놓은 정도가 님께서 말한 정도라 라이센스 정도만 남기면 될 것 같네요.

보통 github의 readme에 무엇무엇을 적으시나요?

4개의 답변

#readme 목록