mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-09 09:49:10 +02:00

A very fast implementation of tldr in Rust. https://tealdeer-rs.github.io/tealdeer/

hacktoberfest rust tldr

Rust 94.5%
Dockerfile 3.7%
Shell 1.8%

Find a file

Danilo Bargen 11a28d4f74 Add .editorconfig		2016-01-27 17:48:43 +01:00
src	License under MIT/Apache-2.0	2016-01-27 17:48:43 +01:00
.editorconfig	Add .editorconfig	2016-01-27 17:48:43 +01:00
.gitignore	Initial version: Simply print content without formatting	2015-12-29 10:22:37 +01:00
.travis.yml	Add Rust 1.5 to .travis.yml	2016-01-22 08:35:51 +01:00
Cargo.lock	Implement --list flag	2016-01-27 17:39:17 +01:00
Cargo.toml	License under MIT/Apache-2.0	2016-01-27 17:48:43 +01:00
LICENSE-APACHE	License under MIT/Apache-2.0	2016-01-27 17:48:43 +01:00
LICENSE-MIT	License under MIT/Apache-2.0	2016-01-27 17:48:43 +01:00
README.md	License under MIT/Apache-2.0	2016-01-27 17:48:43 +01:00

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.