readmeGitLab+1
좋은 README 작성하는 방법
이 글은 ‘좋은 README를 작성하는 방법’을 다뤘습니다. README에는 항상 최신 정보를 담아야 합니다. 아울러 프로젝트에 변경 사항이 생길 때마다 README도 함께 업데이트해야 합니다. README에는 중요한 정보만 간결하게 전달해야 합니다. 이밖에 README에는 프로젝트의 주요 기능과 목적, 설치 방법, 문제 해결 방법, 지원창구, 라이선스 정보, 변경 로그, 사용 예시, 심화 자료와 문서 링크, 사전 요구사항을 담는 걸 권장합니다.
Sabo2023년 8월 23일