Skip to content

Commit 5ba387a

Browse files
committed
update README help with new option
1 parent 020af5c commit 5ba387a

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It will also add example code for any features and optionally for some standard
1111
Running `./pico_project --help` will give a list of the available command line parameters
1212

1313
```
14-
usage: pico_project.py [-h] [-o OUTPUT] [-x] [-l] [-c] [-f FEATURE] [-over] [-b] [-g] [-p PROJECT] [-r] [-uart] [-usb] [name]
14+
usage: pico_project.py [-h] [-t TSV] [-o OUTPUT] [-x] [-l] [-c] [-f FEATURE] [-over] [-b] [-g] [-p PROJECT] [-r] [-uart] [-usb] [name]
1515
1616
Pico Project generator
1717
@@ -20,6 +20,7 @@ positional arguments:
2020
2121
optional arguments:
2222
-h, --help show this help message and exit
23+
-t TSV, --tsv TSV Set an alternative pico_configs.tsv file
2324
-o OUTPUT, --output OUTPUT
2425
Set an alternative CMakeList.txt filename
2526
-x, --examples Add example code for the Pico standard library
@@ -34,7 +35,7 @@ optional arguments:
3435
Generate projects files for IDE. Options are: vscode
3536
-r, --runFromRAM Run the program from RAM rather than flash
3637
-uart, --uart Console output to UART (default)
37-
-usb, --usb Console output to USB (disables other USB functionality)
38+
-usb, --usb Console output to USB (disables other USB functionality
3839
```
3940
You can list the features supported by the tools by using `./pico_project --list`. These features can
4041
be added to the project using the `--feature` options, this can be used multiple times.
@@ -47,7 +48,7 @@ The GUI version of the tool, run by adding `--gui` to the command line, uses `tk
4748

4849
You can add specific features to your project by selecting them from the check boxes on the GUI. This will ensure the build system adds the appropriate code to the build, and also adds simple example code to the project showing how to use the feature. There are a number of options available, which provide the following functionality.
4950

50-
Console Options | Description
51+
Console Options | Description
5152
----------------|-----------
5253
Console over UART | Enable a serial console over the UART. This is the default.
5354
Console over USB | Enable a console over the USB. The device will act as a USB serial port. This can be used in addition to or instead of the UART option, but note that when enabled other USB functionality is not possible.
@@ -62,7 +63,7 @@ Advanced | Brings up a table allowing selection of specific board build options
6263

6364
Build Options | Description
6465
--------------| -----------
65-
Run Build | Once the project has been created, build it. This will produce files ready for download to the Raspberry Pi Pico.
66+
Run Build | Once the project has been created, build it. This will produce files ready for download to the Raspberry Pi Pico.
6667
Overwrite Project | If a project already exists in the specified folder, overwrite it with the new project. This will overwrite any changes you may have made.
6768
Create VSCode Project | As well as the CMake files, also create the appropriate Visual Studio Code project files.
6869

0 commit comments

Comments
 (0)