README 에는 목적이 정해져 있지 않습니다.
말그대로, README 에는 목적이 정해져 있지 않습니다.
오픈소스 프로젝트인 경우는 github 의 메인 파일 역할로 사용되니
이 프로젝트의 소개 및 사용 방법이 기술됩니다. 라이센스는 LICENSE 파일로 따로 명시가 되니까요.
근데 이조차도
어떤 내용이 들어가야 하는지 정해져 있는 게 단 하나도 없습니다.
이전 댓글에서 쓴 대로, 그 리포지토리 주인이라면, 자기 일기 써도 무죄입니다. 진짜 무죄입니다.
물론 오픈소스 플젝인데 그런 짓을 하면 사람들이 안쓰겠지만
실제로 있는 걸 어떻게 합니까. (아래에 예시 첨부해 놨으니까 보시고)
라이센스를 별도로 명시 안해놨다면 README 에다 기재하기도 합니다.
그래서, 소규모 오픈 플젝들 훑어보면 README 에 라이센스만 기재되어 있는 경우도 허다하게 많아요.
그 사람들에게도 뭐라 할 것도 아니고.
그리고 클로즈드 프로젝트에서는 README 아예 안쓰는 프로젝트가 훨씬 많고요
쓰더라도 내용 다 제각각이고
참조가 들어가니 어쨌니 등은 하나도 정해져 있는 게 없습니다.
다른 파일로 문서화만 잘 시켜놓으면 아무 문제도 없어요.
여하튼 예시가 없으면 설득력이 없겠죠.
우선 1번
https://github.com/TheAlgorithms/Java
더 알고리즘이란 프로젝트인데, 들어가보면, 소개글 하나, 가이드라인 링크 등 몇 줄이 전부입니다.
참조가 어쨌네 저쨌네는 적혀있지가 않습니다.
https://github.com/json-iterator/java
JSON 이터레이터 프로젝트인데
README 가 단 두줄입니다.
https://github.com/mikeal/cancer-diaries
README 가 일기입니다.
그분 보고 계세요? README에 일기 쓰면 안되나요? 쓰는 사람 많은데?
https://github.com/hija/MalwareDataScience
이건 어떻고?
이건 독후감인 거 같은데?