프로젝트 소개
tldr-pages는 커뮤니티가 관리하는 명령줄 도구 도움말 페이지를 수집하는 협업 프로젝트입니다. 이 프로젝트의 목표는 기존 man 페이지를 보완하는 더 단순하고 접근하기 쉬운 대안이 되는 것이며, 방대한 매뉴얼보다 실용적인 예제에 초점을 맞춥니다. 저장소에는 UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android, Windows, Cisco IOS, DOS 명령줄 인터페이스 전반의 일반적인 도구에 대한 예제가 계속 늘어나고 있습니다.
README에 따르면 이 프로젝트는 일반적인 man 페이지를 읽기 어려운 문제에서 시작되었습니다. 예를 들어 첫 설명이 사용자가 필요한 일반적인 사용법이 아니라 테이프 드라이브 블록 크기에 관한 내용일 수 있다는 것입니다. 대신 tldr 페이지는 tar 아카이브 추출과 같은 간결하고 일상적인 예제를 보여줍니다.
사용 방법으로는 공식 클라이언트가 있습니다:
- Python 클라이언트: pipx 또는 기타 패키지 관리자로 설치 가능
- Rust 클라이언트(tlrc): Homebrew, Cargo, Windows의 Winget으로 설치 가능
- Node.js 클라이언트: npm install -g tldr로 설치 가능하지만 업데이트가 늦어지고 있음
사용자는 tldr.inbrowser.app 웹 클라이언트로도 볼 수 있으며, PWA를 통해 오프라인 사용을 지원합니다. 또는 최신 릴리스에서 페이지의 PDF 버전을 내려받을 수 있으며, 대부분의 언어 번역판 PDF도 제공됩니다.
기여는 누구나 할 수 있습니다. 기여 방법에는 아직 다루지 않은 자주 사용하는 명령 추가, 기존 페이지 개선, "help wanted" 레이블이 붙은 이슈 작업, 다양한 언어로 페이지 번역 등이 있습니다. 페이지는 Markdown으로 작성되어 쉽게 편집할 수 있으며 풀 리퀘스트로 제출할 수 있습니다. 이 프로젝트는 기여 가이드라인과 거버넌스 문서를 갖추고 환영하고 협업하는 커뮤니티를 강조합니다. 번역 진행 상황 사이트와 Matrix 채팅방도 제공됩니다.
README에는 cheat.sh, devhints, eg, kb, navi, cheat, Command Line Interface Pages, 그리고 더 이상 사용되지 않는 bropages와 같은 유사한 프로젝트도 나열되어 있습니다.
TL;DR이라는 이름은 "Too Long; Didn't Read"의 약자로, 긴 문서 대신 빠르고 읽기 쉬운 명령 도움말을 제공하려는 프로젝트의 목적을 반영합니다.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.