Skip to content

Commit a8fb360

Browse files
committed
Moved Pip installation information to the bottom of README and marked as
optional.
1 parent 6b9bbf0 commit a8fb360

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,6 @@ The GUI version of the tool, run by adding `--gui` to the command line, uses `tk
4848

4949
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.
5050

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_project --gui`.
58-
59-
6051
Console Options | Description
6152
----------------|-----------
6253
Console over UART | Enable a serial console over the UART. This is the default.
@@ -82,3 +73,16 @@ IDE Options | Description
8273
Create VSCode Project | As well as the CMake files, also create the appropriate Visual Studio Code project files.
8374
Debugger | Use the specified debugger in the IDE
8475

76+
77+
## Optional: Installation using Python Pip (Linux)
78+
79+
This application can **optionally** be installed to your system using standard Python installation tools. If you would like to do so, follow the instructions below. If you do not wish to install the application, you can run it from the the pico_project directory.
80+
81+
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`.
82+
83+
The package can then be installed for the current user using: `$ pip install .`, or for all users using `$ sudo pip install .`.
84+
85+
You can now run the application from any directory with `$ pico_project` plus any arguments detailed in this README, e.g. `$ pico_project --gui`.
86+
87+
The package can be uninstalled with `$ pip uninstall pico-project-generator`.
88+

0 commit comments

Comments
 (0)