From 2f3fcce5e4637f085fa746be5c1174012b6719d5 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 22 Nov 2021 18:33:28 +0200 Subject: [PATCH] Convert README to markdown --- examples/arduino-blink/README.md | 21 +++++++++++++ examples/arduino-blink/README.rst | 32 ------------------- examples/arduino-external-libs/README.md | 27 ++++++++++++++++ examples/arduino-external-libs/README.rst | 38 ----------------------- 4 files changed, 48 insertions(+), 70 deletions(-) create mode 100644 examples/arduino-blink/README.md delete mode 100644 examples/arduino-blink/README.rst create mode 100644 examples/arduino-external-libs/README.md delete mode 100644 examples/arduino-external-libs/README.rst diff --git a/examples/arduino-blink/README.md b/examples/arduino-blink/README.md new file mode 100644 index 0000000..1e354e0 --- /dev/null +++ b/examples/arduino-blink/README.md @@ -0,0 +1,21 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-raspberrypi/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-raspberrypi/examples/arduino-blink + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/arduino-blink/README.rst b/examples/arduino-blink/README.rst deleted file mode 100644 index e84aaaf..0000000 --- a/examples/arduino-blink/README.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-raspberrypi/examples/arduino-blink - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Clean build files - > platformio run --target clean diff --git a/examples/arduino-external-libs/README.md b/examples/arduino-external-libs/README.md new file mode 100644 index 0000000..8aa6a5f --- /dev/null +++ b/examples/arduino-external-libs/README.md @@ -0,0 +1,27 @@ +How to build PlatformIO based project +===================================== + +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +2. Download [development platform with examples](https://github.com/platformio/platform-raspberrypi/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-raspberrypi/examples/arduino-external-libs + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Build specific environment +$ pio run -e pico + +# Upload firmware for the specific environment +$ pio run -e pico --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/arduino-external-libs/README.rst b/examples/arduino-external-libs/README.rst deleted file mode 100644 index 0207a56..0000000 --- a/examples/arduino-external-libs/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. Copyright 2014-present PlatformIO - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -How to build PlatformIO based project -===================================== - -1. `Install PlatformIO Core `_ -2. Download `development platform with examples `_ -3. Extract ZIP archive -4. Run these commands: - -.. code-block:: bash - - # Change directory to example - > cd platform-raspberrypi/examples/arduino-external-libs - - # Build project - > platformio run - - # Upload firmware - > platformio run --target upload - - # Build specific environment - > platformio run -e pico - - # Upload firmware for the specific environment - > platformio run -e pico --target upload - - # Clean build files - > platformio run --target clean