Skip to content

Commit

Permalink
More documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
earlephilhower committed Apr 6, 2021
1 parent 735c14a commit af1d595
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
9 changes: 5 additions & 4 deletions docs/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Posting complete details, in a polite and organized way will get the best
response.

For bugs in the Core, or to submit patches, please use the
[GitHub Issues](https://github.com/earlephilhower/arduino-pico/issues) or
[GitHub Pull Requests](https://github.com/earlephilhower/arduino-pico/pulls)
`GitHub Issues <https://github.com/earlephilhower/arduino-pico/issues>`_ or
`GitHub Pull Requests <https://github.com/earlephilhower/arduino-pico/pulls>`_

For general questions/discussions use either [GitHub Discussions](https://github.com/earlephilhower/arduino-pico/discussions)
or live-chat with [gitter](https://gitter.im/arduino-pico/community)
For general questions/discussions use either
`GitHub Discussions <https://github.com/earlephilhower/arduino-pico/discussions>`_
or live-chat with `gitter.im <https://gitter.im/arduino-pico/community>`_

3 changes: 3 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,15 @@ follow the initial procedure of holding the BOOTSEL button down while plugging i
Uploading Filesystem Images
---------------------------
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

* https://github.com/earlephilhower/arduino-pico-littlefs-plugin/releases

To install, follow the directions in

* https://github.com/earlephilhower/arduino-pico-littlefs-plugin/blob/master/README.md

For detailed usage information, please check the repo documentation available at

* https://arduino-pico.readthedocs.io/en/latest/fs.html

Uploading Sketches with Picoprobe
Expand Down
2 changes: 1 addition & 1 deletion docs/libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ the generic versions available in the Library Manager

* `Adafruit GFX Library <https://github.com/Bodmer/Adafruit-GFX-Library>`_ by @Bodmer, 2-20x faster than the standard version on the Pico
* `Adafruit ILI9341 Library <https://github.com/Bodmer/Adafruit_ILI9341>`_ again by @Bodmer
* `ESP8266Audio <https://github.com/earlephilhower/ESP8266Audio>_` ported to use the included ``I2S`` library
* `ESP8266Audio <https://github.com/earlephilhower/ESP8266Audio>`_ ported to use the included ``I2S`` library
4 changes: 4 additions & 0 deletions docs/sdk.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Using the Raspberry Pi Pico SDK (PICO-SDK)
==========================================

Included SDK
------------
A complete copy of the `Raspberry Pi Pico SDK <https://datasheets.raspberrypi.org/pico/raspberry-pi-pico-c-sdk.pdf>`_
is included with the Arduino core, and all functions in the core are available
inside the standard link libraries.
Expand Down Expand Up @@ -29,6 +31,8 @@ appropriate header as shown below
libraries are not aware of any changes to the Pico you perform. So,
you may break the functionality of certain libraries in doing so.

Multicore (CORE1) Processing
----------------------------
**Warning:** While you may spawn multicore applications on CORE1
using the SDK, the Arduino core may have issues running properly with
them. In particular, anything involving flash writes (i.e. EEPROM,
Expand Down

0 comments on commit af1d595

Please sign in to comment.