diff --git a/HISTORY.rst b/HISTORY.rst index 52b406e4..87fffb30 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -15,6 +15,8 @@ PlatformIO 2.0 `windows_x86 `__ development platforms (`issue #263 `_) +* Added `PlatformIO Demo `_ + page to documentation * Simplified `installation `__ process of PlatformIO (`issue #274 `_) diff --git a/docs/_static/platformio-demo-lib.gif b/docs/_static/platformio-demo-lib.gif new file mode 100644 index 00000000..238df416 Binary files /dev/null and b/docs/_static/platformio-demo-lib.gif differ diff --git a/docs/_static/platformio-demo-platforms.gif b/docs/_static/platformio-demo-platforms.gif new file mode 100644 index 00000000..3e68a73b Binary files /dev/null and b/docs/_static/platformio-demo-platforms.gif differ diff --git a/docs/_static/platformio-demo-wiring.gif b/docs/_static/platformio-demo-wiring.gif new file mode 100644 index 00000000..a89550bc Binary files /dev/null and b/docs/_static/platformio-demo-wiring.gif differ diff --git a/docs/demo.rst b/docs/demo.rst new file mode 100644 index 00000000..efbaa1aa --- /dev/null +++ b/docs/demo.rst @@ -0,0 +1,50 @@ +.. _demo: + +Demo +==== + +.. contents:: + +Wiring Blink +------------ + +.. image:: _static/platformio-demo-wiring.gif + +Used in demo +~~~~~~~~~~~~ + +1. Source code of `Wiring Blink `_ +2. :ref:`cmd_run` command +3. :option:`platformio run -t upload` command. + +Platform Manager +---------------- + +.. image:: _static/platformio-demo-platforms.gif + +Used in demo +~~~~~~~~~~~~ + +1. :ref:`userguide_platforms` +2. :ref:`cmd_platforms_list` command +3. :ref:`platformio platforms search avr ` command +4. :ref:`platformio platforms show teensy ` command +5. :ref:`cmd_platforms_update` command. + +Library Manager +--------------- + +.. image:: _static/platformio-demo-lib.gif + +Used in demo +~~~~~~~~~~~~ + +1. :ref:`userguide_lib` +2. :ref:`platformio lib search 1-wire ` command +3. :ref:`platformio lib install 54 ` command +4. :ref:`platformio lib search -f mbed ` command +5. :ref:`platformio lib search -k rf ` command +6. :ref:`platformio lib search radiohead ` command +7. :ref:`platformio lib install 124 --version "1.4.0" ` command +8. :ref:`platformio lib show 124 ` command +9. :ref:`cmd_lib_update` command. diff --git a/docs/index.rst b/docs/index.rst index 0b300b73..febb2777 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,6 +64,7 @@ Contents :caption: Getting Started :maxdepth: 2 + demo installation quickstart userguide/index diff --git a/docs/userguide/platforms/index.rst b/docs/userguide/platforms/index.rst index 7a582752..cdb6211e 100644 --- a/docs/userguide/platforms/index.rst +++ b/docs/userguide/platforms/index.rst @@ -1,7 +1,7 @@ .. _userguide_platforms: -Platforms Manager -================= +Platform Manager +================ To print all available commands and options use: