Skip to content

Commit 7cd972c

Browse files
jsm9720justinjoy
authored andcommitted
docs: README.md 문장을 자연스러운 한국어로 다듬기(#1)
1 parent 2f7d301 commit 7cd972c

1 file changed

Lines changed: 11 additions & 17 deletions

File tree

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
# GStreamer101 Handbook
22

3-
> GStreamer를 처음 접하는 사람도 막힘 없이 따라올 수 있도록 만드는, **가장 쉽고 가장 친절한** GStreamer 입문 핸드북입니다.
3+
GStreamer는 강력하지만 처음 배우는 사람에게는 용어도 개념도 낯섭니다.
4+
`pad`, `caps`, `bin`, `element`, `pipeline`, `bus` … 이런 용어들의 개념과 사용 방법이 많은 입문자가 GStreamer에 쉽게 다가가지 못하는 이유입니다.
45

5-
GStreamer는 강력하지만 처음 배우는 사람에게는 용어도 개념도 낯섭니다.
6-
`pad`, `caps`, `bin`, `element`, `pipeline`, `bus`… 공식 문서를 펴자마자 마주치는 이 단어들 때문에 많은 입문자가 첫 페이지에서 좌절합니다.
7-
8-
**GStreamer101 Handbook**은 그 진입 장벽을 낮추기 위해 시작됐습니다.
9-
"동작하는 코드"를 던지고 끝내는 대신, **"왜 이렇게 동작하는가"** 를 끝까지 설명합니다.
6+
**GStreamer101 Handbook**은 그 진입 장벽을 낮추기 위해 만들었습니다.
7+
"동작하는 코드"를 공유하는 데 그치지 않고, **"왜 이렇게 동작하는가"** 를 끝까지 설명합니다.
108

119
---
1210

13-
## 이 핸드북의 약속
11+
## 작성 원칙
1412

15-
- 🐣 **입문자 기준** "당연히 알겠지"를 가정하지 않습니다. 처음 나오는 용어는 반드시 풀어서 설명합니다.
16-
- 🧩 **왜를 설명** 코드를 한 줄씩 뜯어보며 "왜 이렇게 쓰는지"를 함께 다룹니다.
17-
- ▶️ **바로 실행** 모든 예제는 실제로 빌드·실행되며, 기대 출력까지 적어 둡니다.
18-
- 🩹 **에러를 미리 안내** 초심자가 흔히 만나는 에러와 해결책을 함께 정리합니다.
13+
- **입문자 기준:** "당연히 알겠지"를 가정하지 않습니다. 처음 나오는 용어는 반드시 풀어서 설명합니다.
14+
- **이유까지 설명:** 코드를 한 줄씩 뜯어보며 "왜 이렇게 쓰는지"를 함께 다룹니다.
15+
- **바로 실행:** 모든 예제는 실제로 빌드·실행되며, 기대 출력까지 적어 둡니다.
16+
- **에러를 미리 안내:** 초심자가 흔히 만나는 에러와 해결책을 함께 정리합니다.
1917

20-
> 모든 결정의 기준은 단 하나입니다 — **"입문자가 혼자 읽어도 이해되는가?"**
18+
> 모든 결정의 기준은 **"입문자가 혼자 읽어도 이해되는가?"** 입니다.
2119
2220
---
2321

@@ -46,13 +44,11 @@ brew install gstreamer gst-plugins-base gst-plugins-good
4644
gst-launch-1.0 --version
4745
```
4846

49-
> 각 예제 README의 **실행 방법** 섹션에 빌드·실행 명령과 기대 출력이 정리되어 있으니, 예제별 안내를 그대로 따라오면 됩니다.
50-
5147
---
5248

5349
## 목차
5450

55-
> 예제가 추가되면 이 목차에 함께 등록합니다.
51+
예제가 추가되면 이 목차에 함께 등록합니다.
5652

5753
### Basic Tutorial (공식 기반)
5854

@@ -75,8 +71,6 @@ gst-launch-1.0 --version
7571
- 작업 규칙·예제 작성 가이드: [`AGENTS.md`](./AGENTS.md)
7672
- 예제 추가/수정 시 점검 리스트: [`CHECKLIST.md`](./CHECKLIST.md)
7773

78-
새 예제를 추가할 때는 **입문자가 혼자 읽어도 이해되도록** 최대한 상세하고 쉽게 써 주세요.
79-
8074
---
8175

8276
## 라이선스

0 commit comments

Comments
 (0)