Skip to content

Commit 1473a31

Browse files
authored
Mention cargo-flash etc. in readme (probe-rs#1666)
1 parent 77413aa commit 1473a31

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,31 @@ To see what new functionality was added have a look at the [CHANGELOG](CHANGELOG
3333

3434
If you think probe-rs makes your embedded journey more enjoyable or even earns you money, please consider supporting the project on [Github Sponsors](https://github.com/sponsors/probe-rs/) for better support and more features.
3535

36-
## Downloading a file
36+
## Tools
3737

38-
The `cargo-flash` utility can be used as a cargo subcommand to download a compiled Rust program onto a target device. It can also be used to download arbitrary ELF files that might come out of a C/C++ compiler. Have a look at [cargo-flash](./cargo-flash) for more information.
38+
In addition to being a library, probe-rs also includes a suite of tools which can be used for flashing and debugging.
3939

40-
## Better debugging with probe-rs
40+
### Installation
4141

42-
If you are looking for a more extended debugging experience, please have a look at [cargo-embed](./cargo-embed) which provides support for GDB, RTT, and config files.
42+
After installing the necessary [prerequisites](#building), the tools can be installed using `cargo install`:
4343

44-
## VSCode
44+
```bash
45+
cargo install probe-rs --features cli
46+
```
47+
48+
See the [website](https://probe.rs/docs/getting-started/installation/) for a more detailed guide.
49+
50+
### cargo-flash
51+
52+
The `cargo-flash` utility can be used as a cargo subcommand to download a compiled Rust program onto a target device. It can also be used to download arbitrary ELF files that might come out of a C/C++ compiler. Have a look at [cargo-flash](https://probe.rs/docs/tools/cargo-flash/) for more information.
53+
54+
### cargo-embed
55+
56+
If you are looking for a more extended debugging experience, please have a look at [cargo-embed](https://probe.rs/docs/tools/cargo-embed/) which provides support for GDB, RTT, and config files.
57+
58+
### VSCode
4559

46-
We have implemented the [Microsoft DAP protocol](https://microsoft.github.io/debug-adapter-protocol/). This makes embedded debugging via probe-rs available in modern code editors implementing the standard, such as VSCode. Please see [probe-rs-debugger](./debugger) and [vscode](https://github.com/probe-rs/vscode) for more information.
60+
We have implemented the [Microsoft DAP protocol](https://microsoft.github.io/debug-adapter-protocol/). This makes embedded debugging via probe-rs available in modern code editors implementing the standard, such as VSCode. Please see the [website](https://probe.rs/docs/tools/vscode/) for more information.
4761

4862
## Usage Examples
4963

0 commit comments

Comments
 (0)