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/
16 commits 9 branches 20 tags 4 MiB
  • Rust 94.5%
  • Dockerfile 3.7%
  • Shell 1.8%
Find a file
Danilo Bargen 5c75798d19 Implement --version flag
2016-01-06 18:45:01 +01:00
src Implement --version flag 2016-01-06 18:45:01 +01:00
.gitignore Initial version: Simply print content without formatting 2015-12-29 10:22:37 +01:00
.travis.yml Travis config 2015-12-29 14:14:49 +01:00
Cargo.lock Add argument parsing 2016-01-06 08:11:59 +01:00
Cargo.toml Add argument parsing 2016-01-06 08:11:59 +01:00
LICENSE Add README.md 2015-12-29 10:26:56 +01:00
README.md Add goals to README 2016-01-03 23:50:49 +01:00

README.md

tldr-rs

Build status

An implementation of tldr in Rust.

Project goals:

  • Don't require a network connection for anything besides updating the cache
  • Render tldr pages to ANSI terminals
  • Download and cache pages, compatible to the NodeJS client
  • Command line interface similar or equivalent to the NodeJS client
  • Be fast

Building

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