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

Document binary builds in README

Browse source
This commit is contained in:
Danilo Bargen 2018-02-13 18:28:11 +01:00
commit 892b0f2538
1 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -83,23 +83,21 @@ These are the clients I tried but failed to compile or run:
## Installing
### Static Binaries (Linux)
Static binary builds (currently for Linux only) are available on the
[Release page](https://github.com/dbrgn/tealdeer/releases).
Simply download the binary for your platform and run it!
Builds for other platforms are planned.
### Cargo Install (Any platform)
Build and install the tool via cargo...
$ cargo install tealdeer
...or 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 tealdeer-git
### Bash Autocompletion
To get bash autocompletion, simply rename the file `bash_tealdeer` to `tldr`
and copy it to `/usr/share/bash-completion/completions/tldr`.
## Building
### From Source (Any platform)
tealdeer requires at least Rust 1.19.
@ -116,6 +114,19 @@ To enable the log output, set the `RUST_LOG` env variable:
$ export RUST_LOG=tldr=debug
### From AUR (Arch Linux)
If you're an Arch Linux user, you can also install the package from the AUR:
$ yaourt -S tealdeer-git
## Bash Autocompletion
To get bash autocompletion, simply rename the file `bash_tealdeer` to `tldr`
and copy it to `/usr/share/bash-completion/completions/tldr`.
## License
Licensed under either of