platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 10:07:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add new examples to ProjectConfFile + improve Quickstart

Browse Source
This commit is contained in:
Ivan Kravets
2014-08-11 12:20:08 +03:00
parent 80e21f61d3
commit 1b359b7587
2 changed files with 55 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/projectconf.rst
View File

@ -220,14 +220,51 @@ Examples
framework = arduino framework = arduino
board = uno board = uno
upload_port = /dev/ ttyUSB0 upload_port = /dev/ttyUSB0
# upload_port = COM3 # for Windows OS # for Windows OS
# upload_port = COM3
# enable auto-uploading # enable auto-uploading
targets = upload 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 "arduino" bootloader
.. code-block:: ini .. code-block:: ini
@ -238,7 +275,8 @@ Examples
board_f_cpu = 16000000L board_f_cpu = 16000000L
upload_port = /dev/ttyUSB0 upload_port = /dev/ttyUSB0
# upload_port = COM3 # for Windows OS # for Windows OS
# upload_port = COM3
upload_protocol = arduino upload_protocol = arduino
upload_speed = 19200 upload_speed = 19200
@ -246,7 +284,7 @@ Examples
targets = upload 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 ``board_*`` and ``upload_*`` options (use only ``board`` option) and Energia
Wiring-based Framework Wiring-based Framework
@ -258,7 +296,7 @@ Examples
board = lpmsp430g2553 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 .. code-block:: ini

11
docs/quickstart.rst
View File

@ -36,6 +36,17 @@ Initialize new PlatformIO based project
and setup environments in `platformio.ini` file. and setup environments in `platformio.ini` file.
Then process project with `platformio run` command. 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 Process the project's environments
.. code-block:: bash .. code-block:: bash