Template for Capstone

이 레파지토리는 학생들이 캡스톤 프로젝트 결과물을 위한 레파지토리 생성시에 참고할 내용들을 담고 있습니다.

1. 레파지토리 생성
2. 레파지토리 구성
3. 레파지토리 제출
4. README.md 가이드라인
5. README.md 작성팁

---

1. 레파지토리 생성

• https://classroom.github.com/a/iX0VWqGp
• 위 Github Classroom 링크에 접속해 본인 조의 github 레파지토리를 생성하세요.

• 레포지토리 생성 시 팀명은 TEAM-{조 번호} 형식으로 생성하세요.
• 예를 들어, 2024년도 3조의 팀명은 TEAM-03 입니다.
• 이 경우 Capstone2024-TEAM-03이란 이름으로 레파지토리가 생성됩니다.

---

2. 레파지토리 구성

• 레파지토리 내에 README.md 파일 생성하고 아래의 가이드라인과 작성팁을 참고하여 README.md 파일을 작성하세요. (이 레파지토리의 SAMPLE_README.md 참조)
• 레파지토리 내에 docs 디렉토리를 생성하고 docs 디렉토리 내에는 과제 수행 하면서 작성한 각종 보고서, 발표자료를 올려둡니다. (이 레파지토리의 docs 디렉토리 참조)
• 그 밖에 레파지토리의 폴더 구성은 과제 결과물에 따라 자유롭게 구성하되 가급적 코드의 목적이나 기능에 따라 디렉토리를 나누어 구성하세요.

---

3. 레파지토리 제출

• [주의] 레파지토리 제출은 해당 레파지토리의 ownership을 학과 계정으로 넘기는 것이므로 되돌릴 수 없습니다.

• 레파지토리 제출 전, 더 이상 수정 사항이 없는지 다시 한번 확인하세요.

• github 레파지토리에서 Settings > General > Danger zone > Transfer 클릭

• [ Specify an organization or username ]에 'PNUCSE'를 입력하고 확인 메세지를 입력하세요.

---

4. README.md 가이드 라인

• README 파일 작성시에 아래의 5가지 항목의 내용은 필수적으로 포함해야 합니다.
• 아래의 5가지 항목이외에 프로젝트의 이해를 돕기 위한 내용을 추가해도 됩니다.
• SAMPLE_README.md 이 단순한 형태의 예제이니 참고하세요.

### 1. 프로젝트 소개
#### 1.1. 배경 및 필요성
> 프로젝트를 실행하게 된 배경 및 필요성을 작성하세요.

#### 1.2. 목표 및 주요 내용
> 프로젝트의 목표 및 주요 내용을 작성하세요.

### 2. 상세설계
#### 2.1. 시스템 구성도
> 시스템 구성도(infra, front, back등의 node 간의 관계)의 사진을 삽입하세요.

#### 2.1. 사용 기술
> 스택 별(backend, frontend, designer등) 사용한 기술 및 버전을 작성하세요.
> 
> ex) React.Js - React14, Node.js - v20.0.2

### 3. 설치 및 사용 방법
> 제품을 설치하기 위헤 필요한 소프트웨어 및 설치 방법을 작성하세요.
>
> 제품을 설치하고 난 후, 실행 할 수 있는 방법을 작성하세요.

### 4. 소개 및 시연 영상
> 프로젝트에 대한 소개와 시연 영상을 넣으세요.

### 5. 팀 소개
> 팀원 소개 & 구성원 별 역할 분담 & 간단한 연락처를 작성하세요.

5. README.md 작성팁

• 마크다운 언어를 이용해 README.md 파일을 작성할 때 참고할 수 있는 마크다운 언어 문법을 공유합니다.
• 다양한 예제와 보다 자세한 문법은 이 문서를 참고하세요.

5.1. 헤더 Header

# This is a Header 1
## This is a Header 2
### This is a Header 3
#### This is a Header 4
##### This is a Header 5
###### This is a Header 6
####### This is a Header 7 은 지원되지 않습니다.

5.2. 인용문 BlockQuote

> This is a first blockqute.
>	> This is a second blockqute.
>	>	> This is a third blockqute.

This is a first blockqute.

This is a second blockqute.

This is a third blockqute.

5.3. 목록 List

• Ordered List

1. first
2. second
3. third  

1. first
2. second
3. third

• Unordered List

* 하나
  * 둘

+ 하나
  + 둘

- 하나
  - 둘

• 하나
  • 둘

• 하나
  • 둘

• 하나
  • 둘

5.4. 코드 CodeBlock

• 코드 블럭 이용 '``'

여러줄 주석 "```" 이용
"```
#include <stdio.h>
int main(void){
  printf("Hello world!");
  return 0;
}
```"

단어 주석 "`" 이용
"`Hello world`"

* 큰 따움표(") 없이 사용하세요.

5.5. 링크 Link

[Title](link)
[부산대학교 정보컴퓨터공학부](https://cse.pusan.ac.kr/cse/index..do)

<link>
<https://cse.pusan.ac.kr/cse/index..do>

부산대학교 정보컴퓨터공학부

https://cse.pusan.ac.kr/cse/index..do

5.6. 강조 Highlighting

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
~~cancelline~~

single asterisks
single underscores
double asterisks
double underscores
cancelline

5.7. 이미지 Image

<img src="image URL" width="600px" title="Title" alt="Alt text"></img>
![Alt text](image URL "Optional title")

• 웹에서 작성한다면 README.md 내용 안으로 이미지를 드래그 앤 드롭하면 이미지가 생성됩니다.
• 웹이 아닌 로컬에서 작성한다면, github issue에 이미지를 드래그 앤 드롭하여 image url 을 얻을 수 있습니다. (URL만 복사하고 issue는 제출 안 함.)

5.8. 유튜브 영상 추가

[![영상 이름](유튜브 영상 썸네일 URL)](유투브 영상 URL)
[![부산대학교 정보컴퓨터공학부 소개](http://img.youtube.com/vi/zh_gQ_lmLqE/0.jpg)](https://www.youtube.com/watch?v=zh_gQ_lmLqE)    

• 이때 유투브 영상 썸네일 URL은 유투브 영상 URL로부터 다음과 같이 얻을 수 있습니다.

• Youtube URL: https://www.youtube.com/watch?v={동영상 ID}

• Youtube Thumbnail URL: http://img.youtube.com/vi/{동영상 ID}/0.jpg

• 예를 들어, https://www.youtube.com/watch?v=zh_gQ_lmLqE 라고 하면 썸네일의 주소는 http://img.youtube.com/vi/zh_gQ_lmLqE/0.jpg 이다.