diff --git a/HISTORY.rst b/HISTORY.rst index e9e35f69..8ff024cb 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,6 +1,21 @@ Release History =============== +0.9.1 (2014-12-05) +------------------ + +* Ask user to install platform (when it hasn't been installed yet) within + `platformio run `_ + and `platformio show `_ commands +* Improved main `documentation `_ +* Fixed "*OSError: [Errno 2] No such file or directory*" within + `platformio run `_ + command when PlatformIO isn't installed properly +* Fixed example for `Eclipse IDE with Tiva board `_ + (`issue #32 `_) +* Upgraded `Eclipse Project Examples `_ + to latest *Luna* and *PlatformIO* releases + 0.9.0 (2014-12-01) ------------------ diff --git a/docs/_static/ide-platformio-eclipse.png b/docs/_static/ide-platformio-eclipse.png index 8a8dde02..22f4246a 100644 Binary files a/docs/_static/ide-platformio-eclipse.png and b/docs/_static/ide-platformio-eclipse.png differ diff --git a/docs/ide.rst b/docs/ide.rst index ad6fa167..6d8c90eb 100644 --- a/docs/ide.rst +++ b/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 `_ +* `More examples (TI MSP430, TI TIVA and etc) `_ Energia IDE ----------- diff --git a/docs/librarymanager/creating.rst b/docs/librarymanager/creating.rst index e5590f59..b72d8e70 100644 --- a/docs/librarymanager/creating.rst +++ b/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" } diff --git a/docs/platforms/atmelavr.rst b/docs/platforms/atmelavr.rst index ca10dc56..49ad22a9 100644 --- a/docs/platforms/atmelavr.rst +++ b/docs/platforms/atmelavr.rst @@ -30,7 +30,7 @@ Packages - uploader - `AVRDUDE `_ * - ``framework-arduinoavr`` - - + - framework - See below in :ref:`atmelavr_frameworks` diff --git a/docs/platforms/index.rst b/docs/platforms/index.rst index 7e82f934..5a18d479 100644 --- a/docs/platforms/index.rst +++ b/docs/platforms/index.rst @@ -3,9 +3,9 @@ Platforms & Embedded Boards =========================== -*PlatformIO* has pre-built different development platforms for popular OS (Mac, -Linux 32/64/ARM and Windows). Each of them include compiler, debugger, uploader -(for embedded) and many other useful tools. +*PlatformIO* has pre-built different development platforms for popular OS +(*Mac OS X, Linux (+ARMv6) and Windows*). Each of them include compiler, +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 diff --git a/docs/platforms/timsp430.rst b/docs/platforms/timsp430.rst index b1b9c017..22809b5d 100644 --- a/docs/platforms/timsp430.rst +++ b/docs/platforms/timsp430.rst @@ -27,7 +27,7 @@ Packages - uploader - `MSPDebug `_ * - ``framework-energiamsp430`` - - + - framework - See below in :ref:`timsp430_frameworks` diff --git a/docs/platforms/titiva.rst b/docs/platforms/titiva.rst index 54145d98..0b1f7b80 100644 --- a/docs/platforms/titiva.rst +++ b/docs/platforms/titiva.rst @@ -28,7 +28,7 @@ Packages - uploader - `Flash Programmer `_ * - ``framework-energiativa`` - - + - framework - See below in :ref:`titiva_frameworks` .. note:: diff --git a/docs/projectconf.rst b/docs/projectconf.rst index a9f275bd..aa3bf1ba 100644 --- a/docs/projectconf.rst +++ b/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 -------- diff --git a/docs/quickstart.rst b/docs/quickstart.rst index f211fdb2..1fc63923 100644 --- a/docs/quickstart.rst +++ b/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! - Please put your source code to `src` directory, external libraries to `lib` - and setup environments in `platformio.ini` file. - Then process project with `platformio run` command. + The current working directory *** will be used for the new project. + You can specify another project directory via + `platformio init -d %PATH_TO_THE_PROJECT_DIR%` 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 ` .. code-block:: ini diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index 280c6900..fb2ac331 100644 --- a/docs/userguide/cmd_init.rst +++ b/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 diff --git a/docs/userguide/cmd_install.rst b/docs/userguide/cmd_install.rst index bd533b1a..fb7bd53b 100644 --- a/docs/userguide/cmd_install.rst +++ b/docs/userguide/cmd_install.rst @@ -23,7 +23,7 @@ There are several predefined aliases for packages, such as: * ``toolchain`` * ``uploader`` - +* ``framework`` Options ------- diff --git a/examples/ide-eclipse/README.rst b/examples/ide-eclipse/README.rst index 8e02c923..c29734d7 100644 --- a/examples/ide-eclipse/README.rst +++ b/examples/ide-eclipse/README.rst @@ -5,7 +5,7 @@ The detailed information and steps are described in this article: `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO `_. -.. image:: http://www.ikravets.com/wp-content/uploads/2014/06/eclipse_build_arduino_pro5v-1024x822.png +.. image:: http://www.ikravets.com/wp-content/uploads/2014/06/eclipse_platformio_build_arduino_uno.png :width: 850px :target: http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio diff --git a/examples/ide-eclipse/arduino_pro5/.cproject b/examples/ide-eclipse/arduino_pro5/.cproject index d58b4a47..9fdb0166 100644 --- a/examples/ide-eclipse/arduino_pro5/.cproject +++ b/examples/ide-eclipse/arduino_pro5/.cproject @@ -1,7 +1,5 @@ - - - + @@ -13,41 +11,46 @@ + - - + + - - - - - @@ -74,4 +77,5 @@ + diff --git a/examples/ide-eclipse/arduino_pro5/Makefile b/examples/ide-eclipse/arduino_pro5/Makefile deleted file mode 100644 index eb5632a0..00000000 --- a/examples/ide-eclipse/arduino_pro5/Makefile +++ /dev/null @@ -1,5 +0,0 @@ -all: - platformio run -t upload - -clean: - platformio run -t clean diff --git a/examples/ide-eclipse/arduino_pro5/platformio.ini b/examples/ide-eclipse/arduino_pro5/platformio.ini index c39b5c74..b5289605 100644 --- a/examples/ide-eclipse/arduino_pro5/platformio.ini +++ b/examples/ide-eclipse/arduino_pro5/platformio.ini @@ -4,5 +4,4 @@ [env:arduino_pro5v] platform = atmelavr framework = arduino -board = pro16MHzatmega168 -upload_port = /dev/tty.SLAB_USBtoUART \ No newline at end of file +board = pro16MHzatmega168 \ No newline at end of file diff --git a/examples/ide-eclipse/atmelavr_atmega168/.cproject b/examples/ide-eclipse/atmelavr_atmega168/.cproject index bf75df5c..e544fe2b 100644 --- a/examples/ide-eclipse/atmelavr_atmega168/.cproject +++ b/examples/ide-eclipse/atmelavr_atmega168/.cproject @@ -1,7 +1,5 @@ - - - + @@ -13,18 +11,19 @@ + - - + +