생성되는 README 보완
0xd669 opened this issue · comments
기본으로 생성되는 README.md 파일의 기본적인 골격을 좀 더 잡아두어, 추가 문서 작업이 용이하도록 개선하면 좋을 것 같습니다. 그리고 힙-한 배지들도 기본으로 넣어두면 좋겠.. 😅
- 힙-한 배지들 추가
- 내용은 awesome-readme와 괜찮아 보이는 템플릿 등을 참고하겠습니다.
public repo도 생성할 수 있음을 감안하되 주로 레이니스트 개발팀 내부에서 사용함을 감안해보겠습니다...
Contributing과 License 관련 부분은 빼고 가야할거같고 Installation은 라이브러리 일 땐 유의미하나 웹 서버의 경우 애매하므로 범용적으로 쓰일 수 있는 Getting started로 가려합니다. 그 외로 레포 설명 부분을 넣고 더 추가할 수 있는게 뭐가 있을까요?
라이센스는 ios 레포를 참고해보니 © 2019 Rainist Co., Ltd. All rights reserved. 같은 형태로 넣을 순 있어보여서 License 헤더만이라도 넣어둘까 싶습니다.
python-rainist 같은 프라이빗 레포로 fork 해서 거기엔 더 specific한 내용을 넣으면 될지도 고민입니다.