README, 버전 관리 시스템

 

프로젝트란?

• 하나의 프로그램을 만들기 위한 일련의 프로세스.
• 기획, 설계, 소스 코드 구현, 테스트, 배포 등 프로그램을 만들기 위한 모든 과정
• 많은 협업이 필요할 때도 있다.
• -> 협업을 잘하기 위해서는 코드, 문서 공유 등을 통한 소통이 중요하다! 개발자의 필수 역량이며 프로젝트의 성공을 좌우한다. 

 

README의 역할

1. 완성된 프로그램의 설명서

• 프로그램 사용 방법
• 레퍼런스

2. 구현중인 프로젝트의 현황

• 구현된 주요 기능
• 구현 현황
• 코드가 해결해야하는 문제 등

 

Markdown 작성법

1. 순서가 있는 목록

- 순서가 없는 목록

_기울여_

**굵게**

**_기울여 굵게_**

# 제목 1~6단계

개행은 역슬래쉬 \\ ( -> 깃허브, 디스코드에선 다르게 사용 )

백틱 3개```

프로그래밍 코드는 줄의 제일 앞에 공백 4칸 이상 띄워서 쓰면 된다.

공백이 사라지면 코드 종료로 인식한다

> 인용문1 ( 리드미에서 강조할 때 인용문 빈번히 사용 )

https://www.markdownguide.org/basic-syntax/

Basic Syntax | Markdown Guide

 

 

깃허브는 마크다운이 다르다? : GitHub Flavored Markdown

개발자 지향적으로 약간 수정된, GitHub Flavored Markdown.

같은 문법으로 디스코드도 사용하고 있다.

https://github.github.com/gfm/

GitHub Flavored Markdown Spec

 

 

버전 관리 시스템 (Version Control System, VCS)

버전: 유의미한 수정

• 버전 관리
• 백업 복구
• 협업

 

버전 관리 시스템의 종류

크게 세 가지.

• 로컬 VCS
  • 내 컴퓨터 안에서만 사용
  • 협업 불가능
  • 백업 필요
• 중앙집중식 VCS
  • 중앙 서버에서 모든 파일의 변경 이력을 관리하는 방식
  • SVN, CVS
  • 동기화 필요
  • 서버 다운 시 작업 중단 가능성
• 분산 VCS
  • 중앙 서버뿐만 아니라 각 사용자의 로컬 컴퓨터에도 전체 저장소의 복사본을 저장하는 방식
  • Git, Mercurial, Bazaar
  • 로컬에서 전체 저장소 복사본 관리 -> 중앙 서버 없이도 작업 가능
  • 병합과 분기 기능 강력
  • 유연한 워크플로우 가능