GitHub 실습 보고서 참고 - dhryu60/SmartDevice_2025-1 GitHub Wiki

GitHub 실습 보고서 / 참고

1. GitHub 소개 (5분)

GitHub란?

  • 소스 코드 버전 관리 및 협업 도구
  • Git을 기반으로 한 클라우드 서비스
  • 프로젝트 버전 관리 및 협업, 문서 작성에 사용

GitHub의 주요 용도

  • 소스 코드 저장 및 버전 관리
  • 팀 협업 및 코드 리뷰
  • 프로젝트 문서화 (README, Wiki 등)
  • 개인/팀 프로젝트 포트폴리오 관리

2. GitHub 계정 생성 및 기본 설정 (5분)

계정 생성

  1. [GitHub 홈페이지](https://github.com) 방문
  2. Sign Up 클릭 후 이메일, 비밀번호 입력
  3. 사용자 이름 설정 및 인증 절차 완료

Git 설치 및 기본 설정

  1. Git 다운로드 및 설치 ([Git 다운로드 링크](https://git-scm.com/downloads))
  2. 설치 후 터미널에서 아래 명령어 실행
$ git config --global user.name "사용자이름"
$ git config --global user.email "이메일주소"

3. 실습 보고서 작성용 Repository 생성 (10분)

Repository 생성

  1. GitHub 로그인
  2. New Repository 클릭
  3. Repository 이름 입력 (예: IoT_Reports)
  4. Public/Private 선택 후 Create Repository 클릭

로컬 저장소와 연결

  1. 터미널에서 원하는 폴더로 이동
$ cd 원하는_폴더_경로
  1. Git 초기화 및 GitHub Repository 연결
$ git init
$ git remote add origin https://github.com/사용자이름/IoT_Reports.git

4. 실습 보고서 작성 요령 (10분)

Markdown 문법 기본

GitHub의 README나 보고서는 주로 Markdown 문법을 사용하여 작성합니다.

Markdown 기본 문법

  1. 제목: #, ##, ###로 계층 구조 표시
    # 제목1
    ## 제목2
    ### 제목3
    
  2. 리스트:
    • 순서 없는 리스트: - 또는 *
    • 순서 있는 리스트: 숫자 사용 (예: 1., 2.)
    - 항목1
    - 항목2
    
    1. 첫 번째
    2. 두 번째
    
  3. 코드 블록: 백틱(```) 사용
    ```python
    print("Hello, World!")
    
  4. 링크: [텍스트](URL)
    [GitHub](https://github.com)
    
  5. 이미지 삽입:
    ![이미지 설명](이미지 URL)
    

실습 보고서 샘플 템플릿

# 실습 제목

## 실습 목적
- 실습의 목적과 목표를 간단히 작성합니다.

## 실습 내용
1. 주요 코드 설명
2. 결과 이미지 첨부

## 실습 결과
- 실험 결과와 분석 내용을 작성합니다.

## 문제점 및 개선 사항
- 실습 중 겪었던 문제점과 개선 방안을 기록합니다.

5. Git을 활용한 보고서 업로드 (5분)

파일 업로드 과정

  1. 작성한 보고서를 Repository에 추가
$ git add .
  1. 변경 사항 커밋
$ git commit -m "Add 실습1 보고서"
  1. GitHub에 업로드 (Push)
$ git push origin main

수정 내용 반영하기

  1. 파일 수정 후 다시 Add, Commit, Push
$ git add .
$ git commit -m "Update 실습1 보고서"
$ git push origin main

6. 실습 보고서 제출 방법 (5분)

  1. GitHub Repository에 보고서 업로드 후 URL 복사
  2. 단톡방에 링크 공유
    • 예: https://github.com/사용자이름/IoT_Reports/blob/main/실습1.md

제출 시 유의 사항

  • 보고서 파일명은 일관성 있게 설정 (예: 실습1.md)
  • Markdown 문법 준수 및 결과 이미지 첨부
  • 모든 파일은 GitHub에 최신 상태로 유지

7. Q&A 및 실습 (5분)

Q&A 시간

  • GitHub 및 Markdown 사용 관련 질문 받기

실습 과제

  1. GitHub 계정 생성 및 Repository 생성
  2. Markdown 파일로 간단한 실습 보고서 작성
  3. 작성한 보고서를 GitHub에 업로드 후 링크 제출