feedc0de/platformio-core
1
0
Fork 0
forked from platformio/platformio-core
Code Pull Requests Activity

Improve QuickStart steps

Browse Source
This commit is contained in:
Ivan Kravets
2015-01-08 20:12:42 +02:00
parent 2672f2c7f6
commit dcf325f64e
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/quickstart.rst
View File

@ -12,8 +12,8 @@ Quickstart
2. Find board ``type`` on this :ref:`Embedded Boards <platforms>` page or 2. Find board ``type`` on this :ref:`Embedded Boards <platforms>` page or
via :ref:`cmd_boards` command. via :ref:`cmd_boards` command.
3. Initialize new PlatformIO based project with the pre-configured 3. Initialize new PlatformIO based project via :ref:`cmd_init` command with the
environments for your boards: pre-configured environments for your boards:
.. code-block:: bash .. code-block:: bash
@ -31,10 +31,13 @@ Quickstart
Project has been successfully initialized! Project has been successfully initialized!
Now you can process it with `platformio run` command. Now you can process it with `platformio run` command.
More detailed information about this command is here :ref:`cmd_init`. Put your source code ``*.h, *.c, *.cpp or *.ino`` files to ``src`` directory.
4. Process the project's environments. 4. Process the project's environments.
Change working directory to the project's root where is located
:ref:`Project Configuration File (platformio.ini) <projectconf>` and run:
.. code-block:: bash .. code-block:: bash
$ platformio run $ platformio run