Git(13) 리드미(ReadMe)와 위키(wiki)란

리드미가 뭔지 위키가 뭔지 대충 감이라도 잡아보자

 

깃헙 프로젝트 페이지의 대문 : Readme.md

- 깃헙 프로젝트 페이지 열자마자 소스코드 섹션과  + 그 아래에 Readme 섹션이 있다. 소개글 느낌..? 

- Read me 에는 / 어떤 프로젝트인지, / 스택과 / 시스템 아키텍쳐 / 그리고 팀원소개 / 등 내용을 한 눈에 볼 수 있도록 담아야 한다.

- 해당 프로젝트의 버전, 이전 버전과 변경사항들, 파일 목록, 시스템 구조도 등을 작성하여 사용자들이 특이 사항들을 바로 알 수 있다.

 

** Read me 는 일반적으로 아래와 같은 정보들을 가지고 있다.

README	일반 정보
AUTHORS	제작 정보
THANKS	도와주신 분들에 대한 정보
ChangeLog	프로그래머들이 참고 할 수 있는 자세한 체인지로그
NEWS	사용자들이 참고할 수 있는 기본적인 체인지로그
INSTALL	설치 안내
COPYING/LICENSE	저작권 및 사용권 정보
BUGS	알려진 버그 및 새로운 버그 보고 방법 안내

 

** Read me 간단한 예시  github.com/MLstate/opalang

 

프로젝트 설명서 : github wiki

- readme 가 소개와 개요라면 위키는 사용설명서 같은 거다. ex) 깃헙 페이지에 따로 위키코너가 마련되어 있음 

- Wiki 에 documentation 을 충실히 하고 소스 및 README.md 에 link 로 연결 할 수 있다. 

- 위키 특성  많은 사람들이 함께 만들 수 있다.

 

 

** wiki 간단한 예시 - 링크를 클릭하면 해당 페이지로 이동 github.com/MLstate/opalang/wiki