mirror of
https://github.com/platformio/platformio-core.git
synced 2025-10-17 16:25:23 +02:00
102 lines
3.7 KiB
ReStructuredText
102 lines
3.7 KiB
ReStructuredText
.. Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
.. _ide_clion:
|
|
|
|
CLion
|
|
=====
|
|
|
|
The `CLion <https://www.jetbrains.com/clion/>`_ is a cross-platform C/C++ IDE
|
|
for Linux, OS X, and Windows integrated with the CMake build system. The
|
|
initial version will support the GCC and Clang compilers and GDB debugger.
|
|
Clion includes such features as a smart editor, code quality assurance,
|
|
automated refactorings, project manager, integrated version control systems.
|
|
|
|
This software can be used with:
|
|
|
|
* all available :ref:`platforms`
|
|
* all available :ref:`frameworks`
|
|
|
|
Refer to the `CDT Documentation <https://www.jetbrains.com/clion/documentation/>`_
|
|
page for more detailed information.
|
|
|
|
.. contents::
|
|
|
|
Integration
|
|
-----------
|
|
|
|
Project Generator
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
Since PlatformIO 2.0 you can generate CLion compatible project using
|
|
:option:`platformio init --ide` command. Please choose board type using
|
|
:ref:`cmd_boards` command and run:
|
|
|
|
.. code-block:: shell
|
|
|
|
platformio init --ide clion --board %TYPE%
|
|
|
|
Then:
|
|
|
|
1. Import this project via ``Menu: File > Import Project``
|
|
and specify root directory where is located :ref:`projectconf`
|
|
2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
|
|
3. Build project: ``Menu: Run > Build``.
|
|
|
|
There are 3 predefined targets for building:
|
|
|
|
* ``PLATFORMIO_BUILD`` - build project without auto-uploading
|
|
* ``PLATFORMIO_UPLOAD`` - build and upload (if no errors)
|
|
* ``PLATFORMIO_CLEAN`` - clean compiled objects and etc.
|
|
|
|
.. warning::
|
|
The libraries which are added, installed or used in the project
|
|
after generating process wont be reflected in IDE. To fix it you
|
|
need to reinitialize project using :ref:`cmd_init` (repeat it).
|
|
|
|
.. warning::
|
|
PlatformIO generates empty project by default and **code auto-completion
|
|
will not work!** To enable auto-completion please choose one of:
|
|
|
|
* Add source files ``*.c, *.cpp, etc`` to ``src`` directory and re-initialize
|
|
project with command above
|
|
* Manually correct ``add_executable`` command in ``CMakeLists.txt`` file
|
|
(will be created in project directory after initialization).
|
|
|
|
``*.ino`` file isn't acceptable for ``add_executable`` command. You should
|
|
convert it manually to ``*.cpp``. See `project example <https://github.com/platformio/platformio/tree/develop/examples/ide/clion>`_.
|
|
|
|
More info `CLion issue #CPP-3977 <https://youtrack.jetbrains.com/issue/CPP-3977>`_.
|
|
Active discussion is located in
|
|
`PlatformIO issue #132 <https://github.com/platformio/platformio/issues/132>`_.
|
|
|
|
Articles / Manuals
|
|
------------------
|
|
|
|
* `Using PlatformIO to get started with Arduino in CLion IDE <http://www.ches.pl/using-platformio-get-started-arduino-clion-ide/>`_
|
|
* `Programar con Arduino "The good way" (Programming with Arduino "The good way", Spanish) <http://congdegnu.es/2015/11/09/programar-con-arduino-the-good-way/>`_
|
|
|
|
See a full list with :ref:`articles`.
|
|
|
|
Screenshot
|
|
----------
|
|
|
|
.. image:: ../_static/ide-platformio-clion.png
|
|
:target: http://docs.platformio.org/en/latest/_static/ide-platformio-clion.png
|
|
|
|
Examples
|
|
--------
|
|
|
|
"Blink" Project
|
|
^^^^^^^^^^^^^^^
|
|
|
|
Source code of `CLion "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/clion>`_.
|