Improve documentation

HISTORY.rst

@@ -1,11 +1,13 @@
 Release History
 ===============
 
-0.9.1 (2014-12-03)
+0.9.1 (?)
-------------------
+---------
 
-* Fixed "*OSError: [Errno 2] No such file or directory*" when PlatformIO isn't
+* Fixed "*OSError: [Errno 2] No such file or directory*" for
-  installed properly
+  `platformio run <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_run.html>`_
+  command when PlatformIO isn't installed properly
+* Improved main `documentation <http://docs.platformio.ikravets.com>`_
 * Fixed example for `Eclipse IDE with Tiva board <https://github.com/ivankravets/platformio/tree/develop/examples/ide-eclipse>`_
   (`issue #32 <https://github.com/ivankravets/platformio/issues/32>`_)
 

docs/ide.rst

@@ -19,6 +19,7 @@ Eclipse
     :target: http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio
 
 * `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_
+* `More examples (TI MSP430, TI TIVA and etc) <https://github.com/ivankravets/platformio/tree/develop/examples/ide-eclipse>`_
 
 Energia IDE
 -----------

docs/librarymanager/creating.rst

@@ -50,7 +50,9 @@ Example:
         {
             "type": "git",
             "url": "https://github.com/shirriff/Arduino-IRremote.git"
-        }
+        },
+        "frameworks": "arduino",
+        "platforms": "atmelavr"
     }
 
 Under CVS (SVN/GIT)
@@ -83,7 +85,9 @@ Example:
         {
             "type": "git",
             "url": "https://code.google.com/p/xbee-arduino/"
-        }
+        },
+        "frameworks": "arduino",
+        "platforms": "atmelavr"
     }
 
 Self-hosted
@@ -114,7 +118,9 @@ of **required** fields in the :ref:`library_config` will look like:
         },
         "version": "2.2",
         "downloadUrl": "http://www.pjrc.com/teensy/arduino_libraries/OneWire.zip",
-        "include": "OneWire"
+        "include": "OneWire",
+        "frameworks": "arduino",
+        "platforms": "atmelavr"
     }
 
 

docs/platforms/atmelavr.rst

@@ -30,7 +30,7 @@ Packages
       - uploader
       - `AVRDUDE <http://www.nongnu.org/avrdude/>`_
     * - ``framework-arduinoavr``
-      -
+      - framework
       - See below in :ref:`atmelavr_frameworks`
 
 

docs/platforms/index.rst

@@ -3,9 +3,9 @@
 Platforms & Embedded Boards
 ===========================
 
-*PlatformIO* has pre-built different development platforms for popular OS (Mac,
+*PlatformIO* has pre-built different development platforms for popular OS
-Linux 32/64/ARM and Windows). Each of them include compiler, debugger, uploader
+(*Mac OS X, Linux (+ARMv6) and Windows*). Each of them include compiler,
-(for embedded) and many other useful tools.
+debugger, uploader (for embedded) and many other useful tools.
 
 Also it has pre-configured settings for most popular **Embedded Platform
 Boards**. You have no need to specify in :ref:`projectconf` type or frequency of

docs/platforms/timsp430.rst

@@ -27,7 +27,7 @@ Packages
       - uploader
       - `MSPDebug <http://mspdebug.sourceforge.net>`_
     * - ``framework-energiamsp430``
-      -
+      - framework
       - See below in :ref:`timsp430_frameworks`
 
 

docs/platforms/titiva.rst

@@ -28,7 +28,7 @@ Packages
       - uploader
       - `Flash Programmer <http://www.ti.com/tool/lmflashprogrammer>`_
     * - ``framework-energiativa``
-      -
+      - framework
       - See below in :ref:`titiva_frameworks`
 
 .. note::

docs/projectconf.rst

@@ -113,6 +113,9 @@ This option is used by "uploader" tool to send firmware to the board via
 * ``/dev/ttyUSB0`` - Unix-based OS
 * ``COM3`` - Windows OS
 
+If ``upload_port`` isn't specified, then *PlatformIO* will try to detect
+``upload_port`` automatically.
+
 To print all available serial ports use :ref:`cmd_serialports` command.
 
 
@@ -142,6 +145,8 @@ When no targets are defined, *PlatformIO* will build only sources by default.
     (``targets = upload``).
 
 
+.. _projectconf_build_flags:
+
 ``build_flags``
 ^^^^^^^^^^^^^^^
 
@@ -232,6 +237,8 @@ For more detailed information about available flags/options go to:
 This is option ``srcbuild_flags`` has the same behaviour like ``build_flags``
 but will be applied only for project source code from ``src`` directory.
 
+.. _projectconf_examples:
+
 Examples
 --------
 

docs/quickstart.rst

@@ -13,7 +13,7 @@ Print all available development platforms for installing
 
 .. code-block:: bash
 
-    $ platformio search all
+    $ platformio search
     [ ... ]
 
 
@@ -33,16 +33,22 @@ Initialize new PlatformIO based project
 
 .. code-block:: bash
 
-    $ cd /path/to/empty/directory
     $ platformio init
-    Project has been initialized!
+    The current working directory *** will be used for the new project.
-    Please put your source code to `src` directory, external libraries to `lib`
+    You can specify another project directory via
-    and setup environments in `platformio.ini` file.
+    `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
-    Then process project with `platformio run` command.
+
+    The next files/directories will be created in ***
+    `platformio.ini` - Project Configuration File
+    `src` - a source directory. Put your source code here
+    `lib` - a directory for the project specific libraries
+    Do you want to continue? [y/N]: y
+    Project has been successfully initialized!
+    Now you can process it with `platformio run` command.
 
 
 Setup environments in ``platformio.ini``. For more examples go to
-:ref:`projectconf`
+:ref:`Project Configuration File <projectconf_examples>`
 
 .. code-block:: ini
 

docs/userguide/cmd_init.rst

@@ -45,7 +45,7 @@ Examples
     $ platformio init
     The current working directory *** will be used for the new project.
     You can specify another project directory via
-    `platformio init -d %PATH_TO_PROJECT_DIR%` command.
+    `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
 
     The next files/directories will be created in ***
     platformio.ini - Project Configuration File

docs/userguide/cmd_install.rst

@@ -23,7 +23,7 @@ There are several predefined aliases for packages, such as:
 
 * ``toolchain``
 * ``uploader``
-
+* ``framework``
 
 Options
 -------