Skip to content

Commit ab84075

Browse files
authored
Merge pull request #8 from openmv/update_readme
misc: Update readme.
2 parents a3c5bc0 + 20146f3 commit ab84075

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
# gdbrunner
1+
# πŸ› gdbrunner
22

3-
GDB runner - start debug servers and attach GDB.
3+
A simple CLI tool that starts a GDB server and automatically attaches GDB to debug embedded targets.
44

5-
## Installation
5+
## ✨ Features
6+
7+
- πŸ”Œ **Multiple backends** - Supports J-Link and ST-Link debug probes
8+
- πŸ” **Auto-discovery** - Automatically finds STM32CubeProgrammer installation
9+
- 🧹 **Clean lifecycle** - Starts the server, attaches GDB, and cleans up when done
10+
- βš™οΈ **Configurable** - JSON-based backend configuration for easy customization
11+
12+
## πŸ“¦ Installation
613

714
```bash
815
pip install gdbrunner
916
```
1017

11-
## Usage
18+
## πŸš€ Usage
1219

1320
```bash
1421
gdbrunner <backend> [options] elf
@@ -22,18 +29,21 @@ gdbrunner <backend> [options] elf
2229
### Examples
2330

2431
```bash
25-
# Start J-Link and attach GDB
32+
# πŸ”§ Start J-Link and attach GDB
2633
gdbrunner jlink --device STM32H743VI firmware.elf
2734

28-
# Start ST-Link and attach GDB
29-
gdbrunner stlink --cube-prog /path/to/cubeprog firmware.elf
35+
# πŸ”§ Start ST-Link and attach GDB (auto-discovers CubeProgrammer path)
36+
gdbrunner stlink firmware.elf
3037

31-
# Dry run - print server command without running
38+
# πŸ‘€ Dry run - print server command without running
3239
gdbrunner jlink --device STM32H743VI --dryrun firmware.elf
40+
41+
# πŸ“Ί Show server output for debugging connection issues
42+
gdbrunner stlink --show-output firmware.elf
3343
```
3444

3545
Run `gdbrunner --help` for all options.
3646

37-
## License
47+
## πŸ“„ License
3848

3949
MIT

0 commit comments

Comments
Β (0)