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”的名字！
