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
2
Cargo.lock
generated
2
Cargo.lock
generated
|
|
@ -1,5 +1,5 @@
|
|||
[root]
|
||||
name = "tldr"
|
||||
name = "tealdeer"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"ansi_term 0.7.2 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
|
|
|
|||
12
Cargo.toml
12
Cargo.toml
|
|
@ -1,13 +1,17 @@
|
|||
[package]
|
||||
name = "tldr"
|
||||
version = "0.1.0"
|
||||
name = "tealdeer"
|
||||
version = "0.2.0"
|
||||
authors = ["Danilo Bargen <mail@dbrgn.ch>"]
|
||||
repository = "https://github.com/dbrgn/tldr-rs/"
|
||||
homepage = "https://github.com/dbrgn/tldr-rs/"
|
||||
repository = "https://github.com/dbrgn/tealdeer/"
|
||||
homepage = "https://github.com/dbrgn/tealdeer/"
|
||||
license = "MIT/Apache-2.0"
|
||||
readme = "README.md"
|
||||
description = "Fetch and show tldr help pages for many CLI commands. Full featured offline client with caching support."
|
||||
|
||||
[[bin]]
|
||||
name = "tldr"
|
||||
path = "src/main.rs"
|
||||
|
||||
[features]
|
||||
logging = ["env_logger"]
|
||||
dev = ["clippy"]
|
||||
|
|
|
|||
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:
|
||||
|
||||
|
|
|
|||
BIN
deer.png
Normal file
BIN
deer.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
52
deer.svg
Normal file
52
deer.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 409 KiB |
|
|
@ -46,11 +46,11 @@ impl Cache {
|
|||
}
|
||||
};
|
||||
|
||||
// Otherwise, fall back to ~/.cache/tldr-rs
|
||||
// Otherwise, fall back to ~/.cache/tealdeer
|
||||
let home_dir = try!(env::home_dir().ok_or(
|
||||
CacheError("Could not determine home directory".into())
|
||||
));
|
||||
Ok(home_dir.join(".cache").join("tldr-rs"))
|
||||
Ok(home_dir.join(".cache").join("tealdeer"))
|
||||
}
|
||||
|
||||
/// Download the archive
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
//! An implementation of [tldr](https://github.com/tldr-pages/tldr) in Rust.
|
||||
//
|
||||
// Copyright (c) 2015-2016 tldr-rs developers
|
||||
// Copyright (c) 2015-2016 tealdeer developers
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
|
|
@ -54,7 +54,7 @@ use formatter::print_lines;
|
|||
use types::OsType;
|
||||
|
||||
|
||||
const NAME: &'static str = "tldr-rs";
|
||||
const NAME: &'static str = "tealdeer";
|
||||
const VERSION: &'static str = env!("CARGO_PKG_VERSION");
|
||||
const USAGE: &'static str = "
|
||||
Usage:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue