Skip to content

Commit 62f4a31

Browse files
committed
Update README.md
1 parent abf675c commit 62f4a31

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,43 @@
11
# Debugprobe
22

3-
Firmware source for the Debug Probe SWD/UART accessory. Can also be run on a Pico.
3+
Firmware source for the Raspberry Pi Debug Probe SWD/UART accessory. Can also be run on a Raspberry Pi Pico.
4+
5+
[Raspberry Pi Debug Probe product page](https://www.raspberrypi.com/products/debug-probe/)
6+
[Raspberry Pi Pico product page](https://www.raspberrypi.com/products/raspberry-pi-pico/)
7+
48

59
# Documentation
610

711
Debug Probe documentation can be found in the [Pico Getting Started Guide](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf). See "Appendix A: Using the Debug Probe".
812

913
# Hacking
1014

11-
For the purpose of making changes or studying of the code, you may want to compile the code yourself.
15+
For the purpose of making changes or studying of the code, you may want to compile the code yourself.
1216

13-
To compile this project firstly initialize and update the submodules:
17+
First, clone the repository:
18+
```
19+
git clone https://github.com/raspberrypi/debugprobe
20+
cd debugprobe
21+
```
22+
Initialize and update the submodules:
1423
```
1524
git submodule update --init
1625
```
17-
then create and switch to the build directory:
26+
Then create and switch to the build directory:
1827
```
1928
mkdir build
2029
cd build
2130
```
22-
then run cmake and build the code:
31+
If your environment doesn't contain `PICO_SDK_PATH`, then either add it to your environment variables with `export PICO_SDK_PATH=/path/to/sdk` or add `PICO_SDK_PATH=/path/to/sdk` to the arguments to CMake below.
32+
33+
Run cmake and build the code:
2334
```
2435
cmake ..
2536
make
2637
```
2738
Done! You should now have a `debugprobe.uf2` that you can upload to your Debug Probe via the UF2 bootloader.
2839

29-
If you want to create the version that runs on the Raspberry Pi Pico, then you need to invoke `cmake` in the sequence above with the `DEBUG_ON_PICO=ON` option:
40+
If you want to create the version that runs on the Pico, then you need to invoke `cmake` in the sequence above with the `DEBUG_ON_PICO=ON` option:
3041
```
3142
cmake -DDEBUG_ON_PICO=ON ..
3243
```

0 commit comments

Comments
 (0)