Enhance doc

This commit is contained in:
Ivan Kravets
2015-12-26 01:02:44 +02:00
parent 319636f017
commit d2088e7444
7 changed files with 24 additions and 25 deletions

View File

@ -51,7 +51,7 @@ Embedded Development. *Easier Than Ever.*
* Cloud compiling and :ref:`ci` with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
* Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>` and
configurable build :ref:`-flags/-options <projectconf_build_flags>`
* Pre-built tool chains, :ref:`frameworks` for the
* Pre-built toolchains, :ref:`frameworks` for the
:ref:`Development Platforms <platforms>`
Smart Code Builder. *Fast and Reliable.*

View File

@ -25,28 +25,27 @@ computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
System requirements
-------------------
* **Operating systems:**
* Mac OS X
* Linux, +ARM
* Windows
* Python 2.6.x or Python 2.7.x(recommended)
:Operating System: Mac OS X, Linux (+ARM) or Windows
:Python Interpreter:
All commands below should be executed in
`Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
application (Terminal):
Python 2.6 or 2.7. Python 2.7 is recommended
* Mac OS X / Linux *Terminal* application
* Windows ``cmd.exe`` application.
.. attention::
**Windows Users**: Please `Download the latest Python 2.7.x
<https://www.python.org/downloads/>`_ and install it.
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
"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
--------------------
.. warning::
**Windows OS**: Please `Download the latest Python 2.7.x
<https://www.python.org/downloads/>`_ and install it.
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
"Customize" stage.
Please *choose ONE of* the following methods:
a) Python Package Manager

View File

@ -19,10 +19,10 @@ for the different development platforms via single command :ref:`cmd_run`
without any dependent software or requirements.
For this purpose *PlatformIO* uses own pre-configured platforms data:
build scripts, tool chains, the settings for the most popular embedded
build scripts, toolchains, the settings for the most popular embedded
boards and etc. These data are pre-built and packaged to the different
``packages``. It allows *PlatformIO* to have multiple development platforms
which can use the same packages(tool chains, frameworks), but have
which can use the same packages(toolchains, frameworks), but have
different/own build scripts, uploader and etc.
.. note::

View File

@ -44,7 +44,7 @@ Options
``home_dir``
^^^^^^^^^^^^
Is used to store platform tool chains, frameworks, external libraries,
Is used to store platform toolchains, frameworks, external libraries,
service data and etc.
A default value is User's home directory:
@ -398,7 +398,7 @@ Example:
^^^^^^^^^^^^^^^^
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
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>`_.
* 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>`_,
`#351 <https://github.com/platformio/platformio/issues/351#issuecomment-161789165>`_,
`#236 <https://github.com/platformio/platformio/issues/236#issuecomment-112038284>`_,

View File

@ -14,7 +14,7 @@
Quickstart
==========
.. note::
.. hint::
Please read `Get Started <http://platformio.org/#!/get-started>`_
article from the official WebSite.

View File

@ -73,7 +73,7 @@ Initialise PlatformIO project for the specified IDE which can be imported later
via "Import Project" functionality.
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::
--enable-auto-uploading

View File

@ -19,7 +19,7 @@ class NativePlatform(BasePlatform):
"""
Native development platform is intended to be used for desktop OS.
This platform uses built-in tool chains (preferable based on GCC),
This platform uses built-in toolchains (preferable based on GCC),
frameworks, libs from particular OS where it will be run.
http://platformio.org/#!/platforms/native