Convert README to markdown

platformio · Nov 22, 2021 · 6f9f4e4 · 6f9f4e4
1 parent 53e417b
commit 6f9f4e4
Show file tree

Hide file tree

Showing 14 changed files with 159 additions and 236 deletions.
diff --git a/examples/arduino-blink/README.md b/examples/arduino-blink/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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/arduino-blink
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Build specific environment
+$ pio run -e teensy31
+
+# Upload firmware for the specific environment
+$ pio run -e teensy31 --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/arduino-blink/README.rst b/examples/arduino-blink/README.rst
diff --git a/examples/arduino-hid-usb-mouse/README.md b/examples/arduino-hid-usb-mouse/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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/arduino-hid-usb-mouse
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/arduino-hid-usb-mouse/README.rst b/examples/arduino-hid-usb-mouse/README.rst
diff --git a/examples/arduino-internal-libs/README.md b/examples/arduino-internal-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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/arduino-internal-libs
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Build specific environment
+$ pio run -e teensy31
+
+# Upload firmware for the specific environment
+$ pio run -e teensy31 --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/arduino-internal-libs/README.rst b/examples/arduino-internal-libs/README.rst
diff --git a/examples/mbed-blink/README.md b/examples/mbed-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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/mbed-blink
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/mbed-blink/README.rst b/examples/mbed-blink/README.rst
diff --git a/examples/mbed-dsp/README.md b/examples/mbed-dsp/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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/mbed-dsp
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/mbed-dsp/README.rst b/examples/mbed-dsp/README.rst
diff --git a/examples/mbed-events/README.md b/examples/mbed-events/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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/mbed-events
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Clean build files
+$ pio run --target clean
+```
diff --git a/examples/mbed-events/README.rst b/examples/mbed-events/README.rst
diff --git a/examples/mbed-serial/README.md b/examples/mbed-serial/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-teensy/archive/develop.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-teensy/examples/mbed-serial
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Clean build files
+$ pio run --target clean
+```