15분
처음 보는 라이브러리를 써야 할 때
Day 3: GitHub README 해독
처음 보는 라이브러리를 써야 할 때
영어 문서 독해: API 문서, GitHub, Stack Overflow > Day 3: GitHub README 해독
학습 목표
GitHub README를 읽어야 하는 상황을 이해한다 README의 기본 구조를 파악한다
"이 라이브러리 써봐"
팀장: "LangChain 써본 적 있어? 이번 프로젝트에 쓸 건데."
솔직히 처음 들어본다. 구글에 "LangChain 사용법" 검색.
블로그들이 나온다. 근데 다 코드가 조금씩 다르다. 어떤 건 되고 어떤 건 안 된다.
결국 GitHub에 갔다.
에디터 로딩 중...
영어다. 하지만 구조가 보인다. 어디서 설치하고, 어디서 시작하는지 알 수 있다.
GitHub README = 라이브러리의 사용 설명서
왜 README를 읽어야 하나?
| 블로그 | GitHub README |
|---|---|
| 오래된 버전 | 최신 버전 |
| 개인 의견 | 공식 정보 |
| 일부만 설명 | 전체 설명 |
| 작동 안 할 수도 | 검증된 코드 |
README를 읽을 수 있으면:
- 새 라이브러리를 빠르게 파악할 수 있다
- 설치 오류를 줄일 수 있다
- 공식 예제로 시작할 수 있다
README 기본 구조
거의 모든 README는 이 순서를 따른다:
에디터 로딩 중...
오늘은 이 구조를 읽는 법을 배운다.