tealdeer/README.md

tldr-rs

An implementation of tldr in Rust.

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 the NodeJS client
• Be fast
• Support all major platforms

Building

tldr-rs requires at least Rust 1.5.

Debug build with logging enabled:

$ cargo build --features logging

Release build without logging:

$ cargo build --release

To enable the log output, set the RUST_LOG env variable:

$ export RUST_LOG=tldr=debug

License

Licensed under either of

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

Contribution

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