[Github] README.md 생성, 마크다운 문법, 작성 예시

 

README.md 파일 생성 방법

 

1. Github에 접속하여 자신의 프로젝트 Repository를 접속하면, README.md 파일이 생성되어 있지 않을 경우 아래와 같이

'Add a README' 라는 버튼이 활성화 되어 있다.

 

또는

 

 

2. 'Add a README' 버튼을 클릭 하고 아래와 같이 'Edit' 편집 영역에서 내용을 작성한다.

 

 

3. 작성한 내용을 'Preview' 를 눌러 확인 할 수 있다. 입력을 완료 했으면 'Commit changes...' 버튼을 클릭한다.

 

 

4. Commit message와 Excended description을 입력하고,
'commit changes' 버튼을 눌러 README.md 파일을 생성한다.

 

 

5. Repository 루트에 README.md 파일이 생성 된 것을 확인할 수 있다.

 

 

 

README.md 마크 다운 문법

Markdown은 간단하고 직관적인 문법을 사용하여 텍스트를 서식화할 수 있는 마크업 언어입니다. 아래는 일반적으로 사용되는 Markdown 문법의 요약입니다.

 

1. 제목 (Headers)

 

# 문자를 사용하여 제목을 만듭니다. #의 개수에 따라 제목의 레벨이 결정됩니다.

# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

preview

 

 

2. 텍스트 서식 (Text Formatting)

 

굵게와 기울임 텍스트를 만들 수 있습니다.

**굵은 텍스트**
*기울임 텍스트*

preview

 

3. 리스트 (Lists)

 

순서가 있는 리스트와 순서가 없는 리스트를 만들 수 있습니다.

 

순서가 없는 리스트 (Unordered Lists)

- 아이템 1
- 아이템 2
  - 서브아이템 1
  - 서브아이템 2

preview

 

순서가 있는 리스트 (Ordered Lists)

1. 첫 번째 아이템
2. 두 번째 아이템
   1. 서브아이템 1
   2. 서브아이템 2

preview

 

4. 링크 (Links)

 

클릭 가능한 링크를 추가할 수 있습니다.

[링크 텍스트](https://example.com)

preview

 

5. 이미지 (Images)

 

이미지를 추가할 수 있습니다.

![이미지 설명](https://tistory1.daumcdn.net/tistory/7013025/attach/fd2afb737f5e4cbdbbe636dda8348115)

preview

 

6. 코드 블록 (Code Blocks)

 

단일 행 코드와 여러 행 코드 블록을 작성할 수 있습니다.

 

인라인 코드 (Inline Code)

`코드`

preview

 

여러 행 코드 블록 (Code Blocks)

```
여러 행의 
코드 블록
```

preview

 

또는

 

특정 언어를 지정하여 문법 강조를 할 수 있습니다.

```java
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

preview

 

 

7. 인용 블록 (Blockquotes)

인용 블록을 만들 수 있습니다.

> 인용 텍스트

preview

 

8. 수평선 (Horizontal Rules)

 

수평선을 그을 수 있습니다. - 또는 * 3개 이상 작성 시 수평선

---
***

preview

 

9. 표 (Tables)

 

표를 작성할 수 있습니다.

| 헤더 1 | 헤더 2 |
|--------|--------|
| 셀 1   | 셀 2   |
| 셀 3   | 셀 4   |

preview

 

이와 같은 Markdown을 사용하면 쉽게 텍스트를 서식화하고, 프로젝트 정보를 깔끔하게 정리할 수 있습니다.

 

 

README.md 작성 예시

# Vennygo
Vennygo는 개인 홈페이지를 위한 웹 애플리케이션입니다. 이 프로젝트는 Java Spring Boot와 thymeleaf를 사용하여 개발합니다.

  
## 🖥️ 프로젝트 소개
Vennygo는 [베니고](https://www.vennygo.com)의 프로젝트이며, 개인 일기와 포트폴리오를 관리하기 위해 개발하고 있습니다.

  
## 🕰️ 개발 기간
* 24.05.04일 ~

### 🧑‍🤝‍🧑 맴버구성
 - vennygo

### ⚙️ 개발 환경
- **Language** : Java 17
- **Framework** : Springboot (3.2.5)
- **Database** : MariaDB
- **ORM** : JPA
- **Frontend**: Thymeleaf
- **Build**: Gradle

### 🖥️ 서버 환경
- Tomcat 10.0.x
- JSP 3.0
- Servlet 5.0
- JDK 17
- MariaDB 10.1.x UTF-8

  
## ❗️ 시작하기
이 섹션에서는 프로젝트를 로컬에서 설정하고 실행하는 방법을 설명합니다.

### Prerequisites(전제조건)
- JDK 17 이상

### 설치
1. 저장소를 클론합니다.
2. 백엔드 설정:
3. 프론트 설정:

  
## 🌐 배포 방법
#### ROOT.war

  
## 📌 주요 기능
#### 메인
- about

#### 회원가입
- 기본 가입
- 소셜 회원 가입

#### 로그인
- Spring Security
- 기본 로그인
- 소셜 로그인

https://github.com/Vennygo/vennygo/blob/master/README.md

vennygo/README.md at master · Vennygo/vennygo