From 888967eb617b5f0ecae390a681e2f5c4263d1fbc Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Thu, 3 Mar 2016 16:39:58 +0200 Subject: [PATCH] Minor improvements to docs --- README.rst | 6 +++--- docs/_static/extra.css | 6 ++++++ docs/demo.rst | 2 +- docs/ide/_platformio_ide_extra.rst | 3 +-- docs/ide/atom.rst | 3 +-- docs/ide/qtcreator.rst | 2 +- docs/ide/visualstudio.rst | 2 +- docs/index.rst | 11 ++++++++--- docs/installation.rst | 14 +++++++++++++- docs/userguide/lib/index.rst | 1 + docs/userguide/platforms/index.rst | 1 + platformio/__init__.py | 2 +- 12 files changed, 38 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 2c086bcf..ca52aa95 100644 --- a/README.rst +++ b/README.rst @@ -45,7 +45,7 @@ PlatformIO :target: http://platformio.org `PlatformIO `_ 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. * **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 :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 tool named `SCons `_. 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 :target: http://platformio.org - :alt: PlatformIO Code Builder Architecture + :alt: PlatformIO Build System Architecture Single source code. *Multiple platforms.* ----------------------------------------- diff --git a/docs/_static/extra.css b/docs/_static/extra.css index a90e062e..61bc0108 100644 --- a/docs/_static/extra.css +++ b/docs/_static/extra.css @@ -256,6 +256,12 @@ nav { /* 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 { color: #e0e0e0; background: url("../_static/platformio-logo-xs.png") no-repeat; diff --git a/docs/demo.rst b/docs/demo.rst index 947219d7..b7487222 100644 --- a/docs/demo.rst +++ b/docs/demo.rst @@ -17,7 +17,7 @@ Demo & Projects .. contents:: Project Examples -^^^^^^^^^^^^^^^^ +---------------- Preconfigured demo projects are located in `PlatformIO GitHub `_ repository. diff --git a/docs/ide/_platformio_ide_extra.rst b/docs/ide/_platformio_ide_extra.rst index 5f52c985..2dc0bf3e 100644 --- a/docs/ide/_platformio_ide_extra.rst +++ b/docs/ide/_platformio_ide_extra.rst @@ -13,8 +13,7 @@ We are proud to present our official `PlatformIO IDE `_ - The next generation integrated development environment for IoT. - * Cross-platform code builder without external dependencies to the system - software: + * Cross-platform build system without external dependencies to the OS software: - 200+ embedded boards - 15+ development platforms diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 59ef1d8d..985c10cc 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -16,8 +16,7 @@ PlatformIO IDE for Atom PlatformIO IDE is the next generation integrated development environment for IoT: -* Cross-platform code builder without external dependencies to the system - software: +* Cross-platform build system without external dependencies to the OS software: - 200+ embedded boards - 15+ development platforms diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index 5b0e8ced..bbcf2001 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -102,7 +102,7 @@ On the next steps select any available kit and click Finish button. .. 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 :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index 1c017a16..c7361fe3 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -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 -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 diff --git a/docs/index.rst b/docs/index.rst index 5fd6c62c..78a9b626 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,9 +12,14 @@ 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.** +* **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 pre-built toolchains, debuggers, uploaders and frameworks which work under popular host OS: Mac, Windows, Linux (+ARM) @@ -38,8 +43,8 @@ libOpenCM3, etc.* `Issues `_ * `Blog `_ | `Twitter `_ | - `Hackaday `_ | `Facebook `_ | + `Hackaday `_ | `Reddit `_ Embedded Development. *Easier Than Ever.* @@ -54,7 +59,7 @@ Embedded Development. *Easier Than Ever.* * Pre-built toolchains, :ref:`frameworks` for the :ref:`Development Platforms ` -Smart Code Builder. *Fast and Reliable.* +Smart Build System. *Fast and Reliable.* ---------------------------------------- * Reliable, automatic dependency analysis and detection of build changes diff --git a/docs/installation.rst b/docs/installation.rst index 3768b9de..b1dedf95 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -36,7 +36,8 @@ System requirements **Windows Users**: Please `Download the latest Python 2.7.x `_ and install it. **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: @@ -118,6 +119,17 @@ On *Windows OS* it may look like: # run it 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 `_) as follows: + +.. code-block:: bash + + brew install platformio + Full Guide ~~~~~~~~~~ diff --git a/docs/userguide/lib/index.rst b/docs/userguide/lib/index.rst index 3153ce8c..55626bfb 100644 --- a/docs/userguide/lib/index.rst +++ b/docs/userguide/lib/index.rst @@ -21,6 +21,7 @@ To print all available commands and options use: $ platformio lib --help $ platformio lib COMMAND --help +.. image:: ../../_static/platformio-demo-lib.gif .. toctree:: :maxdepth: 2 diff --git a/docs/userguide/platforms/index.rst b/docs/userguide/platforms/index.rst index 1cd741c1..1d084ccd 100644 --- a/docs/userguide/platforms/index.rst +++ b/docs/userguide/platforms/index.rst @@ -21,6 +21,7 @@ To print all available commands and options use: $ platformio platforms --help $ platformio platforms COMMAND --help +.. image:: ../../_static/platformio-demo-platforms.gif .. toctree:: :maxdepth: 2 diff --git a/platformio/__init__.py b/platformio/__init__.py index 6675d873..a1c249e7 100644 --- a/platformio/__init__.py +++ b/platformio/__init__.py @@ -20,7 +20,7 @@ __version__ = ".".join([str(s) for s in VERSION]) __title__ = "platformio" __description__ = ( "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. " "Arduino and MBED compatible. Ready for Cloud compiling." )