ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-23 08:34:18 +02:00
Code Issues Projects Releases Packages Wiki Activity
tealdeer/README.md
Danilo Bargen 8be166a0dc Add note about required Rust version
2016-01-19 18:35:33 +01:00

840 B
Raw Blame History

tldr-rs

Build status

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

MIT