Skip to content

Commit d681afc

Browse files
committed
Updated README
1 parent 41a3d5f commit d681afc

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pico-project-generator
22

3-
This is a command line or GUI tool, written in Python, to automatically generate a Pico C SDK Project.
3+
This is a command line or GUI tool, written in Python, to automatically generate a Raspberry Pi Pico C SDK Project.
44

55
The tool will generate all required CMake files, program files and VSCode IDE files for the set of features requested.
66

@@ -42,14 +42,21 @@ optional arguments:
4242
You can list the features supported by the tools by using `./pico_project --list`. These features can
4343
be added to the project using the `--feature` options, this can be used multiple times.
4444

45-
46-
4745
## GUI version
4846

4947
The GUI version of the tool, run by adding `--gui` to the command line, uses `tkinter` to provide a platform agnostic script that will run on Linux, Mac and Windows. All the options from the command line tool are also supported in the GUI.
5048

5149
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.
5250

51+
## Installation using Python Pip (Linux)
52+
53+
Clone the repository with: `$ git clone https://github.com/raspberrypi/pico-project-generator` (assuming you are using HTTP to clone repositories). Change to the repository's directory with: `$ cd pico-project-generator`.
54+
55+
The package can then be installed for the current user using: `$ pip install .`, or for the all system users using `$ sudo pip install .`.
56+
57+
You can now run the package with `$ pico_project` plus any arguments detailed below, e.g. `$ pico_generator --gui`.
58+
59+
5360
Console Options | Description
5461
----------------|-----------
5562
Console over UART | Enable a serial console over the UART. This is the default.
@@ -75,11 +82,3 @@ IDE Options | Description
7582
Create VSCode Project | As well as the CMake files, also create the appropriate Visual Studio Code project files.
7683
Debugger | Use the specified debugger in the IDE
7784

78-
79-
80-
81-
82-
83-
84-
85-

0 commit comments

Comments
 (0)