mirror of
https://github.com/tealdeer-rs/tealdeer.git
synced 2026-08-09 09:49:10 +02:00
Rename project (#26)
* Change name to "tealdeer" * Rename repository as well * Add logo
This commit is contained in:
parent
542500f273
commit
6398f6594f
7 changed files with 76 additions and 14 deletions
16
README.md
16
README.md
|
|
@ -1,9 +1,15 @@
|
|||
# tldr-rs
|
||||
# tealdeer
|
||||
|
||||
[](https://travis-ci.org/dbrgn/tldr-rs)
|
||||

|
||||
|
||||
[](https://travis-ci.org/dbrgn/tealdeer)
|
||||
|
||||
An implementation of [tldr](https://github.com/tldr-pages/tldr) in Rust.
|
||||
|
||||
If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)
|
||||
|
||||
## Goals
|
||||
|
||||
High level project goals:
|
||||
|
||||
- [x] Download and cache pages
|
||||
|
|
@ -11,7 +17,7 @@ High level project goals:
|
|||
- [x] Command line interface similar or equivalent to the [NodeJS client][tldr-node-client]
|
||||
- [x] Be fast
|
||||
|
||||
Usage:
|
||||
## Usage
|
||||
|
||||
tldr [options] <command>
|
||||
tldr [options]
|
||||
|
|
@ -47,12 +53,12 @@ Build and install the tool from source (see section "Building" in this README).
|
|||
|
||||
If you're an Arch Linux user, you can also install the package from the AUR:
|
||||
|
||||
$ yaourt -S tldr-rs-git
|
||||
$ yaourt -S tealdeer-git
|
||||
|
||||
|
||||
## Building
|
||||
|
||||
tldr-rs requires at least Rust 1.6.
|
||||
tealdeer requires at least Rust 1.6.
|
||||
|
||||
Debug build with logging enabled:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue