Skip to content

Commit 952f04d

Browse files
Update install document formatting
1 parent 6b63f71 commit 952f04d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/install.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ to ensure needed device drivers are present.
1919

2020
1. Open up the Arduino IDE and go to File->Preferences.
2121
2. In the dialog that pops up, enter the following URL in the "Additional Boards Manager URLs" field: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
22+
2223
.. image:: images/install1.png
24+
2325
3. Hit OK to close the dialog.
2426
4. Go to Tools->Boards->Board Manager in the IDE
2527
5. Type "pico" in the search box and select "Add":
28+
2629
.. image:: images/install2.png
2730

2831
Installing via GIT
@@ -52,7 +55,7 @@ If you follow their step-by-step you will also have a fully functional
5255
ecosystem.
5356

5457
Uploading Sketches
55-
58+
------------------
5659
To upload your first sketch, you will need to hold the BOOTSEL button down while plugging in the Pico to your computer.
5760
Then hit the upload button and the sketch should be transferred and start to run.
5861

@@ -64,17 +67,19 @@ Them hit the upload button and your sketch should upload and run.
6467
In some cases the Pico will encounter a hard hang and its USB port will not respond to the auto-reset request. Should this happen, just
6568
follow the initial procedure of holding the BOOTSEL button down while plugging in the Pico to enter the ROM bootloader.
6669

67-
# Uploading Filesystem Images
70+
Uploading Filesystem Images
71+
---------------------------
6872
The onboard flash filesystem for the Pico, LittleFS, lets you upload a filesystem image from the sketch directory for your sketch to use. Download the needed plugin from
6973
* https://github.com/earlephilhower/arduino-pico-littlefs-plugin/releases
7074

7175
To install, follow the directions in
7276
* https://github.com/earlephilhower/arduino-pico-littlefs-plugin/blob/master/README.md
7377

74-
For detailed usage information, please check the ESP8266 repo documentation (ignore SPIFFS related notes) available at
75-
* https://arduino-esp8266.readthedocs.io/en/latest/filesystem.html
78+
For detailed usage information, please check the repo documentation available at
79+
* https://arduino-pico.readthedocs.io/en/latest/fs.html
7680

77-
# Uploading Sketches with Picoprobe
81+
Uploading Sketches with Picoprobe
82+
---------------------------------
7883
If you have built a Raspberry Pi Picoprobe, you can use OpenOCD to handle your sketch uploads and for debugging with GDB.
7984

8085
Under Windows a local admin user should be able to access the Picoprobe port automatically, but under Linux `udev` must be told about the device and to allow normal users access.
@@ -90,5 +95,6 @@ The first line creates a file with the USB vendor and ID of the Picoprobe and te
9095

9196
Once Picoprobe permissions are set up properly, then select the board "Raspberry Pi Pico (Picoprobe)" in the Tools menu and upload as normal.
9297

93-
# Debugging with Picoprobe, OpenOCD, and GDB
98+
Debugging with Picoprobe, OpenOCD, and GDB
99+
------------------------------------------
94100
The installed tools include a version of OpenOCD (in the pqt-openocd directory) and GDB (in the pqt-gcc directory). These may be used to run GDB in an interactive window as documented in the Pico Getting Started manuals from the Raspberry Pi Foundation.

0 commit comments

Comments
 (0)