Repository files navigation

Crate	CI (Linux/macOS/Windows)

A very fast implementation oftldr inRust: Simplified, example based and community-driven man pages.

If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)

In case you're in a hurry and just want to quickly try tealdeer, you can find staticbinaries on theGitHub releases page!

User documentation is available athttps://tealdeer-rs.github.io/tealdeer/!

The docs are generated usingmdbook.They can be edited through the markdown files in thedocs/src/ directory.

High level project goals:

• Download and cache pages
• Don't require a network connection for anything besides updating the cache
• Command line interface similar or equivalent to theNodeJS client
• Comply with thetldr client specification
• Advanced highlighting and configuration
• Be fast

A tool liketldr should be as frictionless as possible to use and show theoutput as fast as possible.

We think thattealdeer reaches these goals. We put together a (more or less)reproducible benchmark that compiles a handful of clients from source andmeasures the execution times on a cold disk cache. The benchmarking is run in aDocker container using sharkdp'shyperfine(Dockerfile).

As you can see,tealdeer is one of the fastest of the tested clients.However, we strive for useful features and code quality over raw performance,even if that means that we don't come out on top in this friendly competition.That said, we are still optimizing the code, for example when theoutfieldrdeveloperssuggested to switch to a native TLSimplementation instead of the native libraries.

Creating a debug build with logging enabled:

$ cargo build --features logging

Release build without logging:

$ cargo build --release

To enable the log output, set theRUST_LOG env variable:

$ export RUST_LOG=tldr=debug

To run tests:

$ cargo test

To run lints:

$ rustup component add clippy$ cargo clean && cargo clippy

When publishing a tealdeer release, the Rust version required to build itshould be stable for at least a month.

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT) at your option.

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in the work by you, as defined in the Apache-2.0 license, shallbe dual licensed as above, without any additional terms or conditions.

Thanks to @severen for coming up with the name "tealdeer"!