From 1f95b6be25a34218e764da6ccf1e90f2e27ce1c1 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Sat, 30 Jan 2016 13:41:46 +0200 Subject: [PATCH] Add QuickStart for PlatformIO IDE --- docs/ide/atom.rst | 30 +++++++++++++++++++++++++++++- docs/userguide/cmd_init.rst | 1 - 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index b3c50db9..b7db8574 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -26,8 +26,10 @@ for IoT development: - 10+ frameworks * C/C++ Intelligent code completion -* C/C++ Smart code linter +* C/C++ Smart code linter and super-fast coding * Library Manager for the hundreds popular libraries +* Multi-projects workflow, multiple panes and themes support with dark and light colors +* Serial Port Monitor * Built-in Terminal with :ref:`PlatformIO CLI ` (``pio``, ``platformio``) Atom is a source code editor that's modern, approachable, @@ -81,6 +83,7 @@ Each button contains hint (delay mouse on it). .. image:: ../_static/ide-atom-platformio-toolbar.png * PlatformIO: Build +* PlatformIO: Upload * PlatformIO: Clean * Toggle build panel * | @@ -95,6 +98,31 @@ Each button contains hint (delay mouse on it). * Settings * PlatformIO Documentation +.. _ide_atom_quickstart: + +Quickstart +~~~~~~~~~~ + +:Step 1: + + Create empty directory for the future project. Add it to PlatformIO IDE + using (folder) button on the Toolbar or ``Menu: File > Add Project + Folder...`` + +:Step 2: + + Initialize new PlatformIO based project using ``Menu: PlatformIO > + Initialize new Project (or update existing)`` and select boards. + Put your source code ``*.h, *.c, *.cpp, *.S, *.ino, etc``. files to ``src`` + directory. + +:Step 3: + + Process the project environments. More details :ref:`ide_atom_building_targets`. + + +.. _ide_atom_building_targets: + Building / Uploading / Targets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index 5a4d88a2..dace0f91 100644 --- a/docs/userguide/cmd_init.rst +++ b/docs/userguide/cmd_init.rst @@ -35,7 +35,6 @@ This command will create: * :ref:`projectconf` * ``src`` - a source directory. Put your source files here * ``lib`` - a directory for the project specific (private) libraries. - PlatformIO will compile them to static libraries and link to executable file * ``.travis.yml`` configuration file (template) for Continuous Integration with :ref:`ci_travis`