이 레파지토리는 학생들이 캡스톤 프로젝트 결과물을 위한 레파지토리 생성시에 참고할 내용들을 담고 있습니다.
- 레파지토리 생성
- 레파지토리 구성
- 레파지토리 제출
- README.md 가이드라인
- README.md 작성팁
- https://classroom.github.com/a/nRcUn8vA
- 위 Github Classroom 링크에 접속해 본인 조의 github 레파지토리를 생성하세요.
- 레포지토리 생성 시 팀명은
TEAM-{조 번호}형식으로 생성하세요. - 예를 들어, 2025년도 3조의 팀명은
TEAM-03입니다. - 이 경우
Capstone2025-team-03이란 이름으로 레파지토리가 생성됩니다.
- 레파지토리 내에 README.md 파일 생성하고 아래의 가이드라인과 작성팁을 참고하여 README.md 파일을 작성하세요. (이 레파지토리의 SAMPLE_README.md 참조)
- 레파지토리 내에 docs 디렉토리를 생성하고 docs 디렉토리 내에는 과제 수행 하면서 작성한 각종 보고서, 발표자료를 올려둡니다. (이 레파지토리의 docs 디렉토리 참조)
- 그 밖에 레파지토리의 폴더 구성은 과제 결과물에 따라 자유롭게 구성하되 가급적 코드의 목적이나 기능에 따라 디렉토리를 나누어 구성하세요.
-
[주의]레파지토리 제출은 해당 레파지토리의 ownership을 학과 계정으로 넘기는 것이므로 되돌릴 수 없습니다. -
레파지토리 제출 전, 더 이상 수정 사항이 없는지 다시 한번 확인하세요.
-
github 레파지토리에서 Settings > General > Danger zone > Transfer 클릭
-
[ Specify an organization or username ]에 'PNUCSE'를 입력하고 확인 메세지를 입력하세요.
- README 파일 작성시에 아래의 5가지 항목의 내용은 필수적으로 포함해야 합니다.
- 아래의 항목이외에 프로젝트의 이해를 돕기 위한 내용을 추가해도 됩니다.
- SAMPLE_README.md 이 단순한 형태의 예제이니 참고하세요.
### 1. 프로젝트 배경
#### 1.1. 국내외 시장 현황 및 문제점
> 시장 조사 및 기존 문제점 서술
#### 1.2. 필요성과 기대효과
> 왜 이 프로젝트가 필요한지, 기대되는 효과 등
### 2. 개발 목표
#### 2.1. 목표 및 세부 내용
> 전체적인 개발 목표, 주요 기능 및 기획 내용
#### 2.2. 기존 서비스 대비 차별성
> 유사 서비스 비교 및 차별점 부각
#### 2.3. 사회적 가치 도입 계획
> 프로젝트의 공공성, 지속 가능성, 환경 보호 등
### 3. 시스템 설계
#### 3.1. 시스템 구성도
> 이미지 혹은 텍스트로 시스템 아키텍쳐 작성
>
#### 3.2. 사용 기술
> 프론트엔드, 백엔드, API 등 구체 기술 스택
### 4. 개발 결과
#### 4.1. 전체 시스템 흐름도
> 기능 흐름 설명 및 도식화 가능
>
#### 4.2. 기능 설명 및 주요 기능 명세서
> 주요 기능에 대한 상세 설명, 각 기능의 입력/출력 및 설명
>
#### 4.3. 디렉토리 구조
>
#### 4.4. 산업체 멘토링 의견 및 반영 사항
> 멘토 피드백과 적용한 사례 정리
### 5. 설치 및 실행 방법
>
#### 5.1. 설치절차 및 실행 방법
> 설치 명령어 및 준비 사항, 실행 명령어, 포트 정보 등
#### 5.2. 오류 발생 시 해결 방법
> 선택 사항, 자주 발생하는 오류 및 해결책 등
### 6. 소개 자료 및 시연 영상
#### 6.1. 프로젝트 소개 자료
> PPT 등
#### 6.2. 시연 영상
> 영상 링크 또는 주요 장면 설명
### 7. 팀 구성
#### 7.1. 팀원별 소개 및 역할 분담
>
#### 7.2. 팀원 별 참여 후기
> 개별적으로 느낀 점, 협업, 기술적 어려움 극복 사례 등
### 8. 참고 문헌 및 출처
- 마크다운 언어를 이용해 README.md 파일을 작성할 때 참고할 수 있는 마크다운 언어 문법을 공유합니다.
- 다양한 예제와 보다 자세한 문법은 이 문서를 참고하세요.
# 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 은 지원되지 않습니다.
> 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.
- Ordered List
1. first
2. second
3. third
- first
- second
- third
- Unordered List
* 하나
* 둘
+ 하나
+ 둘
- 하나
- 둘
- 하나
- 둘
- 하나
- 둘
- 하나
- 둘
- 코드 블럭 이용 '``'
여러줄 주석 "```" 이용
"```
#include <stdio.h>
int main(void){
printf("Hello world!");
return 0;
}
```"
단어 주석 "`" 이용
"`Hello world`"
* 큰 따움표(") 없이 사용하세요.
[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
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
~~cancelline~~
single asterisks
single underscores
double asterisks
double underscores
cancelline
<img src="image URL" width="600px" title="Title" alt="Alt text"></img>
- 웹에서 작성한다면 README.md 내용 안으로 이미지를 드래그 앤 드롭하면 이미지가 생성됩니다.
- 웹이 아닌 로컬에서 작성한다면, github issue에 이미지를 드래그 앤 드롭하여 image url 을 얻을 수 있습니다. (URL만 복사하고 issue는 제출 안 함.)
[](유튜브 영상 URL)
[](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 이다.
