취미와 밥줄사이

[GitHub] Wiki란 본문

Tools/Git & GitHub

[GitHub] Wiki란

취미와 밥줄사이 2021. 11. 25. 10:19

Wiki

  • 개발하고 잇는 소스코드를 코드 탭에 올리고 우리가 프로젝트를 진행하며 문서 작업을 할 수 있는데 
  • 이 문서 작업을 할 수 있는 탭이 위키이다.
  • 프로젝트에 대한 설명을 추가하는 것 등 다양한 일을 할 수 있습니다.
  • readme가 소개와 개요라면 위키는 사용설명서와 같은 것입니다.
  • 위크 특성 많은 사람들이 함께 만들 수 있습니다.

 

Wiki 만드는법

  • Github에 가입
  • Respository 생성하기
  • Wiki르 클릭한 후, 아래 녹색버튼(Create the first page) 클릭

 

ReadMe

  • Read me에는 어떤 프로젝트인지, 스택, 시스템 아키텍처, 팀원소개 등 내용을 한 눈에 볼 수 있도록 담아야 한다.
  • 해당 프로젝트의 버전, 이전 버전과 변경사항들, 파일 목록, 시스템 구조도 등을 작서앟여 사용자들이 특이 사항들을 바로 알 수 있다.

 

REFERENCE

https://enth.tistory.com/2

 

GitHub의 Wiki를 개인적으로 활용하기

2016년 9월 6일 화요일 오늘 개인적으로 Wiki 를 알게 되었다. (정보검색용 Wiki 말고) 바로 예시를 보고싶다면, https://github.com/antaehyeon/Hyeon-Schedule/wiki 를 보면 된다. 이동하기 귀찮은 사람들을..

enth.tistory.com

https://devbirdfeet.tistory.com/38

 

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

리드미가 뭔지 위키가 뭔지 대충 감이라도 잡아보자 깃헙 프로젝트 페이지의 대문 : Readme.md - 깃헙 프로젝트 페이지 열자마자 소스코드 섹션과 + 그 아래에 Readme 섹션이 있다. 소개글 느낌..? - Rea

devbirdfeet.tistory.com

 

'Tools > Git & GitHub' 카테고리의 다른 글

[GitHub] Project  (0) 2021.11.25
[GitHub] 협업용 단체 (Organization) 사용법  (0) 2021.11.25
[GitHub] Default 브랜치 전환방법  (0) 2021.10.13
[Git] 작업한 코드 깃허브에 공유하기  (0) 2021.10.12
[Git] Branch 주요 명령어 정리  (0) 2021.10.12
'Tools/Git & GitHub' Related Articles more