tealdeer
Version 1.7.1
| 나무 상자 | CI (Linux/MacOS/Windows) |
|---|---|
 |
Rust에서 TLDR의 매우 빠른 구현 : 단순화, 예제 기반 및 커뮤니티 중심의 사람 페이지.
"TLDR"을 영어로 발음하면 "Tealdeer"와 비슷하게 들립니다. 따라서 프로젝트 이름 :)
서두르고 Tealdeer를 빨리 시험 해보고 싶다면 Github 릴리스 페이지에서 정적 바이너리를 찾을 수 있습니다!
사용자 문서는 https://tealdeer-rs.github.io/tealdeer/에서 확인할 수 있습니다!
문서는 MDBook을 사용하여 생성됩니다. docs/src/ 디렉토리의 Markdown 파일을 통해 편집 할 수 있습니다.
높은 수준의 프로젝트 목표 :
tldr 과 같은 도구는 가능한 한 빨리 출력을 사용하고 표시 할 수있는 마찰이 없어야합니다.
우리는 tealdeer 이러한 목표에 도달한다고 생각합니다. 우리는 소스에서 소수의 클라이언트를 컴파일하고 콜드 디스크 캐시에서 실행 시간을 측정하는 (소수의 클라이언트를 컴파일하는) 재현 가능한 벤치 마크를 구성했습니다. 벤치마킹은 SharkDP의 hyperfine (Dockerfile)을 사용하여 Docker 컨테이너에서 실행됩니다.
| 클라이언트 (50 Runs, 17.10.2021) | 프로그래밍 언어 | MS의 평균 | MS의 편차 | 의견 |
|---|---|---|---|---|
outfieldr | 급격한 변경 | 9.1 | 0.5 | 사용자 구성이 없습니다 |
tealdeer | 녹 | 13.2 | 0.5 | |
fast-tldr | 하스켈 | 17.0 | 0.6 | 강조 표시가 없습니다 |
tldr-hs | 하스켈 | 25.1 | 0.5 | 강조 표시가 없습니다 |
tldr-bash | 세게 때리다 | 30.0 | 0.8 | |
tldr-c | 기음 | 38.4 | 1.0 | |
tldr-python-client | 파이썬 | 87.0 | 2.4 | |
tldr-node-client | JavaScript / nodejs | 407.1 | 12.9 |
보시다시피, tealdeer 테스트 된 클라이언트 중 가장 빠른 클라이언트 중 하나입니다. 그러나 우리는이 친근한 경쟁에서 우리가 최고로 나오지 않더라도 원시 성능에 비해 유용한 기능과 코드 품질을 위해 노력합니다. 예를 들어 outfieldr 개발자가 기본 라이브러리 대신 기본 TLS 구현으로 전환 할 것을 제안한 경우에도 여전히 코드를 최적화하고 있습니다.
로깅이 활성화 된 디버그 빌드 생성 :
$ cargo build --features logging
로깅없이 빌드 릴리스 :
$ cargo build --release
로그 출력을 활성화하려면 RUST_LOG Env 변수를 설정하십시오.
$ export RUST_LOG=tldr=debug
테스트 실행 :
$ cargo test
라인을 실행하려면 :
$ rustup component add clippy
$ cargo clean && cargo clippy
Tealdeer 릴리스를 게시 할 때 Rust 버전을 구축하는 데 필요한 Rust 버전은 최소 한 달 동안 안정적이어야합니다.
어느 쪽에도 라이센스가 부여되었습니다
귀하가 명시 적으로 명시 적으로 명시하지 않는 한, APACHE-2.0 라이센스에 정의 된대로 귀하가 작업에 포함시키기 위해 의도적으로 제출 된 모든 기부금은 추가 이용 약관이나 조건없이 위와 같이 이중 라이센스를받습니다.
"Tealdeer"라는 이름을 생각해 주신 @severen에게 감사합니다!
