forked from platformio/platformio-core
Update docs for IDE & init command
This commit is contained in:
@ -83,34 +83,44 @@ Manual Installation
|
|||||||
Quick Start
|
Quick Start
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
This tutorial introduces you to the basics of PlatformIO IDE workflow and shows you a creation process of a simple "Blink" example. After finishing you will have a general understanding of how to work with projects in the IDE.
|
This tutorial introduces you to the basics of PlatformIO IDE workflow and shows
|
||||||
|
you a creation process of a simple "Blink" example. After finishing you will
|
||||||
|
have a general understanding of how to work with projects in the IDE.
|
||||||
|
|
||||||
Launch
|
Launch
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
PlatformIO IDE is built on top of GitHub's Atom "hackable" text editor.
|
After installation, you launch PlatformIO IDE by opening Atom. Once Atom is
|
||||||
After installation please run one of ``Atom.exe``, ``Atom.app`` or ``atom``
|
open, PlatformIO IDE auto installer will continue to install dependent packages
|
||||||
application depending on the OS.
|
and PlatformIO CLI. Please be patient and let the installation complete. In the
|
||||||
|
final result PlatformIO IDE will ask you to reload Atom window to apply
|
||||||
|
installed components. Please click on ``Reload Now``. After it PlatformIO IDE is
|
||||||
|
ready for using. Happy coding!
|
||||||
|
|
||||||
Setting Up the Project
|
Setting Up the Project
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
1. To create a new project choose ``Menu: PlatformIO > Initialize new Project or update existing`` or press the corresponding icon in the PlatformIO toolbar as shown in the image below:
|
1. To create a new project choose
|
||||||
|
``Menu: PlatformIO > Initialize new Project or update existing`` or press
|
||||||
|
the corresponding icon in the PlatformIO toolbar as shown in the image below:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-1.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-1.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-1.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-1.png
|
||||||
|
|
||||||
2. In the "New Project Menu" choose desired boards (more than one board is allowed) and select a project directory. Then press "Initialize" button:
|
2. In the "New Project Menu" choose desired boards (more than one board is
|
||||||
|
allowed) and select a project directory. Then press "Initialize" button:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-2.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-2.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-2.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-2.png
|
||||||
|
|
||||||
3. If everything is fine, you should see the success message and project tree in the left panel:
|
3. If everything is fine, you should see the success message and project tree
|
||||||
|
in the left panel:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-3.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-3.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-3.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-3.png
|
||||||
|
|
||||||
4. Now, let's create the first project source file: right-click on the folder ``src`` and choose ``New File``:
|
4. Now, let's create the first project source file: right-click on the folder
|
||||||
|
``src`` and choose ``New File``:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-4.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-4.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-4.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-4.png
|
||||||
@ -152,7 +162,8 @@ Copy the next source code to the just created file ``main.cpp``:
|
|||||||
Process Project
|
Process Project
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
PlatformIO IDE proposes different ways to process project (build, clean, upload firmware, run other targets) using:
|
PlatformIO IDE proposes different ways to process project (build, clean,
|
||||||
|
upload firmware, run other targets) using:
|
||||||
|
|
||||||
- :ref:`atom_ide_platformio_toolbar`
|
- :ref:`atom_ide_platformio_toolbar`
|
||||||
- :ref:`atom_ide_platformio_menu`
|
- :ref:`atom_ide_platformio_menu`
|
||||||
@ -181,7 +192,8 @@ And select desired target:
|
|||||||
.. image:: ../_static/ide-atom-platformio-quick-start-9.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-9.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-9.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-9.png
|
||||||
|
|
||||||
7. To run built-in terminal interface choose ``Menu: PlatformIO > Terminal`` or press the corresponding icon in the PlatformIO toolbar:
|
7. To run built-in terminal interface choose ``Menu: PlatformIO > Terminal`` or
|
||||||
|
press the corresponding icon in the PlatformIO toolbar:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-10.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-10.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-10.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-10.png
|
||||||
@ -191,7 +203,8 @@ It provides you fast access to all set of powerful PlatformIO CLI commands:
|
|||||||
.. image:: ../_static/ide-atom-platformio-quick-start-11.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-11.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-11.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-11.png
|
||||||
|
|
||||||
8. To run built-in "Serial Monitor" choose ``Menu: PlatformIO > Serial Monitor`` or press the corresponding icon in the PlatformIO toolbar:
|
8. To run built-in "Serial Monitor" choose ``Menu: PlatformIO > Serial Monitor``
|
||||||
|
or press the corresponding icon in the PlatformIO toolbar:
|
||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-quick-start-12.png
|
.. image:: ../_static/ide-atom-platformio-quick-start-12.png
|
||||||
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-12.png
|
:target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-12.png
|
||||||
|
@ -33,14 +33,11 @@ Initialize new PlatformIO based project or update existing with new data.
|
|||||||
This command will create:
|
This command will create:
|
||||||
|
|
||||||
* :ref:`projectconf`
|
* :ref:`projectconf`
|
||||||
* ``src`` - a source directory. Put your source files here
|
* ``src`` directory where you should place source code
|
||||||
* ``lib`` - a directory for the project specific (private) libraries.
|
(``*.h, *.c, *.cpp, *.S, *.ino, etc.``)
|
||||||
* ``.travis.yml`` configuration file (template) for Continuous Integration
|
* ``lib`` directory can be used for the project specific (private) libraries.
|
||||||
with :ref:`ci_travis`
|
More details are located in ``lib/readme.txt`` file.
|
||||||
|
* Miscellaneous files for CVS and :ref:`ci` support.
|
||||||
.. note::
|
|
||||||
The source code of each library should be placed in separate directory.
|
|
||||||
For example, ``lib/private_lib/[here are source files]``.
|
|
||||||
|
|
||||||
Options
|
Options
|
||||||
-------
|
-------
|
||||||
|
Reference in New Issue
Block a user