Skip to content

PNUCSE/Capstone-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Template for Capstone

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

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

1. 레파지토리 구성

  • 조원 중에 한 사람이 본인 github 계정을 가지고 본인 조에 해당하는 github 레파지토리를 생성하세요. 이 때 이름은 "Capstone-{연도}-{학기}-{조번호}" 형식으로 생성하세요.
  • 예를 들어, 2022년도 1학기(전기) 3조는 "Capstone-2022-1-03" 입니다.
  • 레파지토리 내에 README.md 파일 생성하고 아래의 가이드라인과 작성팁을 참고하여 README.md 파일을 작성하세요. (이 레파지토리의 SAMPLE_README.md 참조)
  • 레파지토리 내에 docs 디렉토리를 생성하고 docs 디렉토리 내에는 과제 수행 하면서 작성한 각종 보고서, 발표자료를 올려둡니다. (이 레파지토리의 docs 디렉토리 참조)
  • 그 밖에 레파지토리의 폴더 구성은 과제 결과물에 따라 자유롭게 구성하되 가급적 코드의 목적이나 기능에 따라 디렉토리를 나누어 구성하세요.

2. 레파지토리 제출

[주의] 레파지토리 제출은 해당 레파지토리의 ownership을 학과 계정으로 넘기는 것이므로 되돌릴 수 없으니 제출전 꼭 다시 한번 확인하세요.

2.1. github 레파지토리의 [Settings] 탭으로 이동, [General] 클릭, [Transfer] 클릭 제출이미지1

2.2. [New owner's Github username or organization name]에 'PNUCSE' 입력하고 confirm 메세지 입력 제출이미지2


3. README.md 가이드라인

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

1. 프로젝트 소개

프로젝트 명, 목적, 개요 등 프로젝트에 대한 간단한 소개글을 작성하세요.

2. 팀 소개

프로젝트에 참여한 팀원들의 이름, 이메일, 역할를 포함해 팀원들을 소개하세요.

3. 구성도

프로젝트 결과물의 개괄적인 동작을 파악할 수 있는 이미지와 글을 작성하세요.

4. 소개 및 시연 영상

프로젝트 소개나 시연 영상을 넣으세요.

5. 사용법

프로젝트 결과을 사용 위해 필요한 소프트웨어 요구사항 및 설치법, 그리고 간단한 사용법을 작성하세요.


3. README.md 작성팁

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

3.1. 텍스트 추가

본문입니다.

# 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

**bold**
_italic_
`code`

1. Ordered
2. List

* Unordered 
* List

<!--주석-->

[link text](URL)

3.2. 이미지 추가

<!--![이미지 이름](이미지 URL 링크)-->
![정보융합공학과 이미지](https://user-images.githubusercontent.com/100384365/192478661-5dc79a18-b076-48ef-b842-bcf65b0d8d44.jpg)

정보융합공학과 이미지

이 때, 이미지 URL은 아래와 같이 github issue를 통해 image file만을 github server에 업로드하고 URL을 얻을 수 있습니다. (URL만 copy하고 issue 제출 X)

이미지 URL 얻기1 이미지 URL 얻기2

3.3. 유튜브 영상 추가

<!--[![영상 이름](유튜브 영상 썸네일 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 이다.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages