ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-09 09:49:10 +02:00
Code Issues Projects Releases Packages Wiki Activity
A very fast implementation of tldr in Rust. https://tealdeer-rs.github.io/tealdeer/
45 commits 9 branches 20 tags 4 MiB
  • Rust 94.5%
  • Dockerfile 3.7%
  • Shell 1.8%
Find a file
Danilo Bargen 0d871091d3 Create Cache::get_platform_dir
2016-01-27 13:55:17 +01:00
src Create Cache::get_platform_dir 2016-01-27 13:55:17 +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 Updater.last_update 2016-01-08 08:40:34 +01:00
Cargo.toml Implement Updater.last_update 2016-01-08 08:40:34 +01:00
LICENSE Add README.md 2015-12-29 10:26:56 +01:00
README.md Add note about required Rust version 2016-01-19 18:35:33 +01:00

README.md

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