mirror of
https://github.com/platformio/platformio-core.git
synced 2025-10-05 10:00:57 +02:00
54 lines
2.0 KiB
ReStructuredText
54 lines
2.0 KiB
ReStructuredText
.. Copyright 2014-present PlatformIO <contact@platformio.org>
|
|
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.
|
|
|
|
.. _core:
|
|
|
|
PlatformIO Core
|
|
===============
|
|
|
|
**PlatformIO Core** is a heart of whole PlatformIO ecosystem and consists of
|
|
|
|
* Multi-platform Build System
|
|
* Development platform and package managers
|
|
* :ref:`librarymanager`
|
|
* :ref:`ldf`
|
|
* :ref:`Serial Port Monitor <cmd_device_monitor>`
|
|
* Integration components (:ref:`ide` and :ref:`ci`).
|
|
|
|
**PlatformIO Core** is written in `Python <https://www.python.org/downloads/>`_
|
|
and works on Windows, macOS, Linux, FreeBSD and *ARM*-based credit-card sized
|
|
computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
|
|
`BeagleBone <http://beagleboard.org>`_,
|
|
`CubieBoard <http://cubieboard.org>`_).
|
|
|
|
|
|
**PlatformIO Core** provides rich and documented Command Line Interface (CLI).
|
|
The other PlatformIO-based software and IDEs are based on
|
|
**PlatformIO Core CLI**, such as :ref:`ide_atom`. In other words, they wrap
|
|
**PlatformIO Core** with own GUI.
|
|
|
|
.. note::
|
|
|
|
Please note that you do not need to install **PlatformIO Core** if you
|
|
are going to use :ref:`ide_atom`. **PlatformIO Core** is built into
|
|
PlatformIO IDE and you will be able to use it within PlatformIO IDE Terminal.
|
|
|
|
Also, PlatformIO IDE allows to install :ref:`core` Shell Commands
|
|
(``pio``, ``platformio``) globally to your system via
|
|
``Menu: PlatformIO > Install Shell Commands``.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
quickstart
|
|
userguide/index
|