Skip to content

Commit 72a644f

Browse files
Update README.md
1 parent a259eb7 commit 72a644f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tools/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
# Tools directory for the RP2040 Arduino-Pico
22

3-
# get.py
3+
## get.py
44
Downloads and installs the toolchain into a GIT clone of the repo. Run
55
once after the `git clone` and any time the toolchain JSON file updates.
66
The `dist` directory caches downloaded toolchain files.
77

8-
# discovery.py
8+
## discovery.py
99
Run in the background by the IDE to scan for UF2 drives to show in the
1010
menus. Normally not run manually by the user.
1111

12-
# uf2conv.py
12+
## uf2conv.py
1313
Manages the upload of the UF2 formatted file to the board. Called as part
1414
of the IDE upload process. Will optionally send the serial reset signal
1515
to get the board into update mode (1200bps connection).
1616

17-
# simplesub.py
17+
## simplesub.py
1818
Very dumb `sed`-like tool used by the platform scripts to generate the
1919
linker `.ld` file (replacing the EEPROM location, FS sizes, etc.).
2020
Because we run on Windows, Mac, and Linux, need to provide this and not
2121
rely on existance of `sed` command.
2222

23-
# pyserial
23+
## pyserial
2424
`git clone` of the PySerial Python3 library to be used by the IDE.
2525

26-
# makeboards.py
26+
## makeboards.py
2727
Generates `boards.txt` programmatically. Never edit the `boards.txt` file
2828
manually, use `python3 tools/makeboards.py > boards.py`. Change the script
2929
as necessary to add any add'l fields or menus required. Used because the
3030
`boards.txt` file is very repetitive and it's safer to generate with code
3131
than by hand.
3232

33-
# libpico/make-libpico.sh
33+
## libpico/make-libpico.sh
3434
Builds the libpico.a file as well as the bootloader stage2 binaries.
3535
Run whenever the pico-sdk is updated.

0 commit comments

Comments
 (0)