search

tealdeer-rs / tealdeer

A very fast implementation of tldr in Rust.
https://tealdeer-rs.github.io/tealdeer/
Apache License 2.0
4.17k stars 123 forks source link

`cargo install tealdeer` should be present in the README #172

Closed Valloric closed 3 years ago

Valloric commented 3 years ago

The string cargo install tealdeer should show up in the README; the earlier in the file, the better.

dbrgn commented 3 years ago

Hi @Valloric, honored to see you here, thanks for your work on YCM!

Anyways, there are multiple ways to install tealdeer, and not every user has rustc / cargo installed.

The first non-intro paragraph in the README says:

2021-04-02-002039_877x34_scrot

For the impatient people that don't read docs, this will get you started right away, just download and run (without any cargo / compilation step).

For people that want a proper installation, there are the user docs:

2021-04-02-002050_886x128_scrot

I think this is the best approach, because it shows different options depending on your favorite way to install binaries (packet manager, cargo, static binaries, etc). cargo install is not necessarily the most user friendly way, because it requires cargo and also requires that you set up your $PATH properly to include $HOME/.cargo/bin.