Skip to content

Commit

Permalink
Mention shell completion in install instructions (#131)
Browse files Browse the repository at this point in the history
Give this reference to users at the time of installation installing
probe-rs so. It will come in handy for sure. It took me some time to
discover this piece of convenience.
  • Loading branch information
sirhcel authored May 25, 2024
1 parent dfa6842 commit 26490b5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,14 @@ You have multiple options, the two most interesting are:
- To try the latest development version (a.k.a the `master` branch) with experimental and unreleased changes, run `cargo install probe-rs-tools --git https://github.com/probe-rs/probe-rs --locked`

See the [Cargo book](https://doc.rust-lang.org/cargo/commands/cargo-install.html) for details.


## Shell completion

You likely want to install shell completion support along with the probe-rs binaries. Just run:

```bash
probe-rs complete install
```

If your shell is not supported out of the box, please follow the instructions given by this command.

0 comments on commit 26490b5

Please sign in to comment.