tealdeer
Version 1.7.1
| 箱 | CI（Linux/MacOS/Windows） |
|---|---|
 |
TLDR在Rust中的非常快速的實現：簡化的，示例和社區驅動的人頁。
如果您用英語發音為“ TLDR”，則聽起來有點像“ TeaLdeer”。因此，項目名稱:)
如果您很著急，只想快速嘗試TeaLdeer，則可以在GitHub版本頁面上找到靜態二進製文件！
用戶文檔可從https://tealdeer-rs.github.io/tealdeer/獲得！
這些文檔是使用MDBook生成的。可以通過docs/src/ Directory中的Markdown文件進行編輯。
高級項目目標：
像tldr這樣的工具應盡可能快地使用並儘快顯示輸出。
我們認為tealdeer實現了這些目標。我們整理了一個（或多或少）可再現的基準測試，該基準從來源中彙編了少數客戶，並測量冷盤緩存上的執行時間。基準測試使用SharkDP的hyperfine （Dockerfile）在Docker容器中運行。
| 客戶（50次運行，17.10.2021） | 程式設計語言 | 平均MS | MS的偏差 | 評論 |
|---|---|---|---|---|
outfieldr | ZIG | 9.1 | 0.5 | 沒有用戶配置 |
tealdeer | 銹 | 13.2 | 0.5 | |
fast-tldr | 哈斯克爾 | 17.0 | 0.6 | 沒有示例突出顯示 |
tldr-hs | 哈斯克爾 | 25.1 | 0.5 | 沒有示例突出顯示 |
tldr-bash | bash | 30.0 | 0.8 | |
tldr-c | c | 38.4 | 1.0 | |
tldr-python-client | Python | 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版本應至少穩定一個月。
根據任何一個
除非您另有明確說明，否則任何有意提交的捐款（如Apache-2.0許可證中定義）應為雙重許可，如上所述，沒有任何其他條款或條件。
感謝@Severen提出了“ TeaLdeer”的名字！
