mirror of
https://github.com/platformio/platformio-core.git
synced 2025-07-31 02:27:13 +02:00
Enhance doc
This commit is contained in:
@ -25,28 +25,27 @@ computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
|
|||||||
System requirements
|
System requirements
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
* **Operating systems:**
|
:Operating System: Mac OS X, Linux (+ARM) or Windows
|
||||||
* Mac OS X
|
:Python Interpreter:
|
||||||
* Linux, +ARM
|
|
||||||
* Windows
|
|
||||||
* Python 2.6.x or Python 2.7.x(recommended)
|
|
||||||
|
|
||||||
All commands below should be executed in
|
Python 2.6 or 2.7. Python 2.7 is recommended
|
||||||
`Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
|
|
||||||
application (Terminal):
|
|
||||||
|
|
||||||
* Mac OS X / Linux – *Terminal* application
|
.. attention::
|
||||||
* Windows – ``cmd.exe`` application.
|
**Windows Users**: Please `Download the latest Python 2.7.x
|
||||||
|
|
||||||
Installation Methods
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
**Windows OS**: Please `Download the latest Python 2.7.x
|
|
||||||
<https://www.python.org/downloads/>`_ and install it.
|
<https://www.python.org/downloads/>`_ and install it.
|
||||||
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
|
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
|
||||||
"Customize" stage.
|
"Customize" stage.
|
||||||
|
|
||||||
|
:Terminal Application:
|
||||||
|
|
||||||
|
All commands below should be executed in
|
||||||
|
`Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
|
||||||
|
application (Terminal). For Mac OS X and Linux OS - *Terminal* application,
|
||||||
|
for Windows OS – ``cmd.exe`` application.
|
||||||
|
|
||||||
|
Installation Methods
|
||||||
|
--------------------
|
||||||
|
|
||||||
Please *choose ONE of* the following methods:
|
Please *choose ONE of* the following methods:
|
||||||
|
|
||||||
a) Python Package Manager
|
a) Python Package Manager
|
||||||
|
@ -398,7 +398,7 @@ Example:
|
|||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Control cyclic (recursive) behaviour for ``Library Dependency Finder (LDF)``.
|
Control cyclic (recursive) behaviour for ``Library Dependency Finder (LDF)``.
|
||||||
By default, this option is turned OFF (``lib_dfcyclic=False``) and means, that
|
By default, this option is turned OFF (``lib_dfcyclic=False``) and means that
|
||||||
``LDF`` will find only libraries which are included in source files from the
|
``LDF`` will find only libraries which are included in source files from the
|
||||||
project :ref:`projectconf_pio_src_dir`.
|
project :ref:`projectconf_pio_src_dir`.
|
||||||
|
|
||||||
@ -453,7 +453,7 @@ Example, specify own upload command for :ref:`platform_atmelavr`:
|
|||||||
|
|
||||||
|
|
||||||
* see built-in examples of `PlatformIO build scripts <https://github.com/platformio/platformio/tree/develop/platformio/builder/scripts>`_.
|
* see built-in examples of `PlatformIO build scripts <https://github.com/platformio/platformio/tree/develop/platformio/builder/scripts>`_.
|
||||||
* take a look on the multiple snippets/answers for the user questions:
|
* take a look at the multiple snippets/answers for the user questions:
|
||||||
`#365 <https://github.com/platformio/platformio/issues/365#issuecomment-163695011>`_,
|
`#365 <https://github.com/platformio/platformio/issues/365#issuecomment-163695011>`_,
|
||||||
`#351 <https://github.com/platformio/platformio/issues/351#issuecomment-161789165>`_,
|
`#351 <https://github.com/platformio/platformio/issues/351#issuecomment-161789165>`_,
|
||||||
`#236 <https://github.com/platformio/platformio/issues/236#issuecomment-112038284>`_,
|
`#236 <https://github.com/platformio/platformio/issues/236#issuecomment-112038284>`_,
|
||||||
|
@ -14,7 +14,7 @@
|
|||||||
Quickstart
|
Quickstart
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. note::
|
.. hint::
|
||||||
Please read `Get Started <http://platformio.org/#!/get-started>`_
|
Please read `Get Started <http://platformio.org/#!/get-started>`_
|
||||||
article from the official WebSite.
|
article from the official WebSite.
|
||||||
|
|
||||||
|
@ -73,7 +73,7 @@ Initialise PlatformIO project for the specified IDE which can be imported later
|
|||||||
via "Import Project" functionality.
|
via "Import Project" functionality.
|
||||||
|
|
||||||
A list with supported IDE is available within ``platformio init --help`` command.
|
A list with supported IDE is available within ``platformio init --help`` command.
|
||||||
Also, please look into :ref:`ide` page.
|
Also, please take a look at :ref:`ide` page.
|
||||||
|
|
||||||
.. option::
|
.. option::
|
||||||
--enable-auto-uploading
|
--enable-auto-uploading
|
||||||
|
Reference in New Issue
Block a user