From 1b359b7587efc2c5e64622581f1a077f094de61e Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 11 Aug 2014 12:20:08 +0300 Subject: [PATCH] Add new examples to ProjectConfFile + improve Quickstart --- docs/projectconf.rst | 50 ++++++++++++++++++++++++++++++++++++++------ docs/quickstart.rst | 11 ++++++++++ 2 files changed, 55 insertions(+), 6 deletions(-) diff --git a/docs/projectconf.rst b/docs/projectconf.rst index 3a1ab0bb..64071051 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -220,14 +220,51 @@ Examples framework = arduino board = uno - upload_port = /dev/ ttyUSB0 - # upload_port = COM3 # for Windows OS + upload_port = /dev/ttyUSB0 + # for Windows OS + # upload_port = COM3 # enable auto-uploading targets = upload -2. :ref:`platform_atmelavr`: Embedded board that is based on ATmega168 MCU with +2. :ref:`platform_atmelavr`: Microduino Core (ATmega168P, 3.3V) board with + auto pre-configured ``board_*`` and ``upload_*`` options (use only + ``board`` option) and Arduino Wiring-based Framework + +.. code-block:: ini + + [env:atmelavr_microduino_core_board] + platform = atmelavr + framework = arduino + board = 168pa8m + + upload_port = /dev/ttyUSB0 + # for Windows OS + # upload_port = COM3 + + # enable auto-uploading + targets = upload + + +3. :ref:`platform_atmelavr`: Raspduino board with + auto pre-configured ``board_*`` and ``upload_*`` options (use only + ``board`` option) and Arduino Wiring-based Framework + +.. code-block:: ini + + [env:atmelavr_raspduino_board] + platform = atmelavr + framework = arduino + board = raspduino + + upload_port = /dev/ttyS0 + + # enable auto-uploading + targets = upload + + +4. :ref:`platform_atmelavr`: Embedded board that is based on ATmega168 MCU with "arduino" bootloader .. code-block:: ini @@ -238,7 +275,8 @@ Examples board_f_cpu = 16000000L upload_port = /dev/ttyUSB0 - # upload_port = COM3 # for Windows OS + # for Windows OS + # upload_port = COM3 upload_protocol = arduino upload_speed = 19200 @@ -246,7 +284,7 @@ Examples targets = upload -3. :ref:`platform_timsp430`: TI MSP430G2553 LaunchPad with auto pre-configured +5. :ref:`platform_timsp430`: TI MSP430G2553 LaunchPad with auto pre-configured ``board_*`` and ``upload_*`` options (use only ``board`` option) and Energia Wiring-based Framework @@ -258,7 +296,7 @@ Examples board = lpmsp430g2553 -4. :ref:`platform_timsp430`: Embedded board that is based on MSP430G2553 MCU +6. :ref:`platform_timsp430`: Embedded board that is based on MSP430G2553 MCU .. code-block:: ini diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9c947c99..e69cbbc3 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -36,6 +36,17 @@ Initialize new PlatformIO based project and setup environments in `platformio.ini` file. Then process project with `platformio run` command. + +Setup environments in ``platformio.ini``. For more examples go to +:ref:`projectconf` + +.. code-block:: ini + + # Simple and base environment + [env:mybaseenv] + platform = %INSTALLED_PLATFORM_NAME_HERE% + + Process the project's environments .. code-block:: bash