Minor improvements to docs

This commit is contained in:
Ivan Kravets
2016-03-03 16:39:58 +02:00
parent 7e0ccd0712
commit 888967eb61
12 changed files with 38 additions and 15 deletions

View File

@ -45,7 +45,7 @@ PlatformIO
:target: http://platformio.org :target: http://platformio.org
`PlatformIO <http://platformio.org>`_ is an open source ecosystem for IoT `PlatformIO <http://platformio.org>`_ is an open source ecosystem for IoT
development. Cross-platform code builder and library manager. Continuous and development. Cross-platform build system and library manager. Continuous and
IDE integration. Arduino and MBED compatible. Ready for Cloud compiling. IDE integration. Arduino and MBED compatible. Ready for Cloud compiling.
* **PlatformIO IDE** - The next generation integrated development environment for IoT. * **PlatformIO IDE** - The next generation integrated development environment for IoT.
@ -130,7 +130,7 @@ platforms which allows you to organize and have up-to-date external libraries.
:target: http://platformio.org :target: http://platformio.org
:alt: PlatformIO Library Manager Architecture :alt: PlatformIO Library Manager Architecture
Smart Code Builder. *Fast and Reliable.* Smart Build System. *Fast and Reliable.*
---------------------------------------- ----------------------------------------
*PlatformIO Code Builder* is built-on a next-generation software construction *PlatformIO Code Builder* is built-on a next-generation software construction
tool named `SCons <http://www.scons.org/>`_. Think of *SCons* as an improved, tool named `SCons <http://www.scons.org/>`_. Think of *SCons* as an improved,
@ -144,7 +144,7 @@ cross-platform substitute for the classic *Make* utility.
.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-scons-builder.png .. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-scons-builder.png
:target: http://platformio.org :target: http://platformio.org
:alt: PlatformIO Code Builder Architecture :alt: PlatformIO Build System Architecture
Single source code. *Multiple platforms.* Single source code. *Multiple platforms.*
----------------------------------------- -----------------------------------------

View File

@ -256,6 +256,12 @@ nav {
/* Misc */ /* Misc */
.wy-side-scroll .wy-side-nav-search .icon,
.wy-side-scroll .wy-side-nav-search .version {
display: none;
visibility: none;
}
.navbar-header .navbar-brand { .navbar-header .navbar-brand {
color: #e0e0e0; color: #e0e0e0;
background: url("../_static/platformio-logo-xs.png") no-repeat; background: url("../_static/platformio-logo-xs.png") no-repeat;

View File

@ -17,7 +17,7 @@ Demo & Projects
.. contents:: .. contents::
Project Examples Project Examples
^^^^^^^^^^^^^^^^ ----------------
Preconfigured demo projects are located in `PlatformIO GitHub <https://github.com/platformio/platformio/tree/develop/examples>`_ repository. Preconfigured demo projects are located in `PlatformIO GitHub <https://github.com/platformio/platformio/tree/develop/examples>`_ repository.

View File

@ -13,8 +13,7 @@
We are proud to present our official `PlatformIO IDE <http://platformio.org/#!/platformio-ide>`_ - We are proud to present our official `PlatformIO IDE <http://platformio.org/#!/platformio-ide>`_ -
The next generation integrated development environment for IoT. The next generation integrated development environment for IoT.
* Cross-platform code builder without external dependencies to the system * Cross-platform build system without external dependencies to the OS software:
software:
- 200+ embedded boards - 200+ embedded boards
- 15+ development platforms - 15+ development platforms

View File

@ -16,8 +16,7 @@ PlatformIO IDE for Atom
PlatformIO IDE is the next generation integrated development environment for IoT: PlatformIO IDE is the next generation integrated development environment for IoT:
* Cross-platform code builder without external dependencies to the system * Cross-platform build system without external dependencies to the OS software:
software:
- 200+ embedded boards - 200+ embedded boards
- 15+ development platforms - 15+ development platforms

View File

@ -102,7 +102,7 @@ On the next steps select any available kit and click Finish button.
.. image:: ../_static/ide-platformio-qtcreator-2.png .. image:: ../_static/ide-platformio-qtcreator-2.png
Secondly, we need to delete default build and clean steps and configure project with PlatformIO source code builder (click on Projects label on left menu or ``Ctrl+5`` shortcut): Secondly, we need to delete default build and clean steps and configure project with PlatformIO Build System (click on Projects label on left menu or ``Ctrl+5`` shortcut):
.. image:: ../_static/ide-platformio-qtcreator-3.png .. image:: ../_static/ide-platformio-qtcreator-3.png
:target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png

View File

@ -64,7 +64,7 @@ First of all, let's create new project from Visual Studio Start Page: ``Start >
.. image:: ../_static/ide-vs-platformio-newproject.png .. image:: ../_static/ide-vs-platformio-newproject.png
Secondly, we need to configure project with PlatformIO source code builder: Secondly, we need to configure project with PlatformIO Build System:
.. image:: ../_static/ide-vs-platformio-newproject-2.png .. image:: ../_static/ide-vs-platformio-newproject-2.png

View File

@ -12,9 +12,14 @@
PlatformIO is an open source ecosystem for IoT development PlatformIO is an open source ecosystem for IoT development
========================================================== ==========================================================
**Cross-platform code builder and library manager. Continuous and IDE **Cross-platform build system and library manager. Continuous and IDE
integration. Arduino and MBED compatible. Ready for Cloud compiling.** integration. Arduino and MBED compatible. Ready for Cloud compiling.**
* **PlatformIO IDE** - The next generation integrated development environment for IoT.
C/C++ Intelligent Code Completion and Smart Code Linter for the super-fast coding.
Multi-projects workflow with Multiple Panes. Themes Support with dark and light colors.
Built-in Terminal with PlatformIO CLI tool and support for the powerful Serial Port Monitor.
All advanced instruments without leaving your favourite development environment.
* **Development Platforms** - Embedded and Desktop development platforms with * **Development Platforms** - Embedded and Desktop development platforms with
pre-built toolchains, debuggers, uploaders and frameworks which work under pre-built toolchains, debuggers, uploaders and frameworks which work under
popular host OS: Mac, Windows, Linux (+ARM) popular host OS: Mac, Windows, Linux (+ARM)
@ -38,8 +43,8 @@ libOpenCM3, etc.*
`Issues <https://github.com/platformio/platformio/issues>`_ `Issues <https://github.com/platformio/platformio/issues>`_
* `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ | * `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
`Twitter <https://twitter.com/PlatformIO_Org>`_ | `Twitter <https://twitter.com/PlatformIO_Org>`_ |
`Hackaday <https://hackaday.io/project/7980-platformio>`_ |
`Facebook <https://www.facebook.com/platformio>`_ | `Facebook <https://www.facebook.com/platformio>`_ |
`Hackaday <https://hackaday.io/project/7980-platformio>`_ |
`Reddit <http://www.reddit.com/r/platformio/>`_ `Reddit <http://www.reddit.com/r/platformio/>`_
Embedded Development. *Easier Than Ever.* Embedded Development. *Easier Than Ever.*
@ -54,7 +59,7 @@ Embedded Development. *Easier Than Ever.*
* Pre-built toolchains, :ref:`frameworks` for the * Pre-built toolchains, :ref:`frameworks` for the
:ref:`Development Platforms <platforms>` :ref:`Development Platforms <platforms>`
Smart Code Builder. *Fast and Reliable.* Smart Build System. *Fast and Reliable.*
---------------------------------------- ----------------------------------------
* Reliable, automatic dependency analysis and detection of build changes * Reliable, automatic dependency analysis and detection of build changes

View File

@ -36,7 +36,8 @@ System requirements
**Windows Users**: Please `Download the latest Python 2.7.x **Windows Users**: 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, otherwise ``pip`` command will not be available. "Customize" stage, otherwise Python Package Manager ``pip`` command
will not be available.
:Terminal Application: :Terminal Application:
@ -118,6 +119,17 @@ On *Windows OS* it may look like:
# run it # run it
C:\Python27\python.exe get-platformio.py C:\Python27\python.exe get-platformio.py
Mac OS X Homebrew
~~~~~~~~~~~~~~~~~
The latest stable version of PlatformIO may be installed or upgraded via
Mac OS X Homebrew Packages Manager (`brew <http://brew.sh/>`_) as follows:
.. code-block:: bash
brew install platformio
Full Guide Full Guide
~~~~~~~~~~ ~~~~~~~~~~

View File

@ -21,6 +21,7 @@ To print all available commands and options use:
$ platformio lib --help $ platformio lib --help
$ platformio lib COMMAND --help $ platformio lib COMMAND --help
.. image:: ../../_static/platformio-demo-lib.gif
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -21,6 +21,7 @@ To print all available commands and options use:
$ platformio platforms --help $ platformio platforms --help
$ platformio platforms COMMAND --help $ platformio platforms COMMAND --help
.. image:: ../../_static/platformio-demo-platforms.gif
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -20,7 +20,7 @@ __version__ = ".".join([str(s) for s in VERSION])
__title__ = "platformio" __title__ = "platformio"
__description__ = ( __description__ = (
"An open source ecosystem for IoT development. " "An open source ecosystem for IoT development. "
"Cross-platform code builder and library manager. " "Cross-platform build system and library manager. "
"Continuous and IDE integration. " "Continuous and IDE integration. "
"Arduino and MBED compatible. Ready for Cloud compiling." "Arduino and MBED compatible. Ready for Cloud compiling."
) )