diff --git a/HISTORY.rst b/HISTORY.rst index 266b83aa..8977ce5e 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,19 +4,19 @@ Release History 0.10.0 (?) ---------- -* Implemented `platformio boards `_ +* Implemented `platformio boards `_ command (`issue #11 `_) * Added support of *Engduino* boards for - `atmelavr `__ + `atmelavr `__ platform (`issue #38 `_) -* Added ``--board`` option to `platformio init `_ +* Added ``--board`` option to `platformio init `_ command which allows to initialise project with the specified embedded boards (`issue #21 `_) -* Added `example with uploading firmware `_ +* Added `example with uploading firmware `_ via USB programmer (USBasp) for - `atmelavr `_ + `atmelavr `_ *MCUs* (`issue #35 `_) -* Automatic detection of port on `platformio serialports monitor `_ +* Automatic detection of port on `platformio serialports monitor `_ (`issue #37 `_) * Allowed auto-installation of platforms when prompts are disabled (`issue #43 `_) * Fixed urllib3's *SSL* warning under Python <= 2.7.2 (`issue #39 `_) @@ -26,7 +26,7 @@ Release History ------------------ * Replaced "dark blue" by "cyan" colour for the texts (`issue #33 `_) -* Added new setting `enable_prompts `_ +* Added new setting `enable_prompts `_ and allowed to disable all *PlatformIO* prompts (useful for cloud compilers) (`issue #34 `_) * Fixed compilation bug on *Windows* with installed *MSVC* (`issue #18 `_) @@ -35,11 +35,11 @@ Release History ------------------ * Ask user to install platform (when it hasn't been installed yet) within - `platformio run `__ - and `platformio show `_ commands -* Improved main `documentation `_ + `platformio run `__ + and `platformio show `_ commands +* Improved main `documentation `_ * Fixed "*OSError: [Errno 2] No such file or directory*" within - `platformio run `__ + `platformio run `__ command when PlatformIO isn't installed properly * Fixed example for `Eclipse IDE with Tiva board `_ (`issue #32 `_) @@ -49,8 +49,8 @@ Release History 0.9.0 (2014-12-01) ------------------ -* Implemented `platformio settings `_ command -* Improved `platformio init `_ command. +* Implemented `platformio settings `_ command +* Improved `platformio init `_ command. Added new option ``--project-dir`` where you can specify another path to directory where new project will be initialized (`issue #31 `_) * Added *Migration Manager* which simplifies process with upgrading to a @@ -67,18 +67,18 @@ Release History 0.8.0 (2014-10-19) ------------------ -* Avoided trademark issues in `library.json `_ - with the new fields: `frameworks `_, - `platforms `_ - and `dependencies `_ +* Avoided trademark issues in `library.json `_ + with the new fields: `frameworks `_, + `platforms `_ + and `dependencies `_ (`issue #17 `_) * Switched logic from "Library Name" to "Library Registry ID" for all - `platformio lib `_ + `platformio lib `_ commands (install, uninstall, update and etc.) -* Renamed ``author`` field to `authors `_ - and allowed to setup multiple authors per library in `library.json `_ -* Added option to specify "maintainer" status in `authors `_ field -* New filters/options for `platformio lib search `_ +* Renamed ``author`` field to `authors `_ + and allowed to setup multiple authors per library in `library.json `_ +* Added option to specify "maintainer" status in `authors `_ field +* New filters/options for `platformio lib search `_ command: ``--framework`` and ``--platform`` 0.7.1 (2014-10-06) @@ -92,15 +92,15 @@ Release History 0.7.0 (2014-09-24) ------------------ -* Implemented new `[platformio] `_ - section for Configuration File with `home_dir `_ +* Implemented new `[platformio] `_ + section for Configuration File with `home_dir `_ option (`issue #14 `_) * Implemented *Library Manager* (`issue #6 `_) 0.6.0 (2014-08-09) ------------------ -* Implemented `platformio serialports monitor `_ (`issue #10 `_) +* Implemented `platformio serialports monitor `_ (`issue #10 `_) * Fixed an issue ``ImportError: No module named platformio.util`` (`issue #9 `_) * Fixed bug with auto-conversation from Arduino \*.ino to \*.cpp @@ -113,7 +113,7 @@ Release History frameworks (`issue #7 `_) * Added `Arduino example `_ with external library (*Adafruit CC3000*) -* Implemented `platformio upgrade `_ +* Implemented `platformio upgrade `_ command and "auto-check" for the latest version (`issue #8 `_) * Fixed an issue with "auto-reset" for *Raspduino* board @@ -122,21 +122,21 @@ Release History 0.4.0 (2014-07-31) ------------------ -* Implemented `platformio serialports `_ command +* Implemented `platformio serialports `_ command * Allowed to put special build flags only for ``src`` files via - `srcbuild_flags `_ + `srcbuild_flags `_ environment option * Allowed to override some of settings via system environment variables such as: ``$PIOSRCBUILD_FLAGS`` and ``$PIOENVS_DIR`` -* Added ``--upload-port`` option for `platformio run `__ command +* Added ``--upload-port`` option for `platformio run `__ command * Implemented (especially for `SmartAnthill `_) - `platformio run -t uploadlazy `_ + `platformio run -t uploadlazy `_ target (no dependencies to framework libs, ELF and etc.) -* Allowed to skip default packages via `platformio install --skip-default-package `_ +* Allowed to skip default packages via `platformio install --skip-default-package `_ option * Added tools for *Raspberry Pi* platform * Added support for *Microduino* and *Raspduino* boards in - `atmelavr `_ platform + `atmelavr `_ platform 0.3.1 (2014-06-21) diff --git a/README.rst b/README.rst index 11ea743f..99366baf 100644 --- a/README.rst +++ b/README.rst @@ -17,26 +17,26 @@ PlatformIO :target: https://pypi.python.org/pypi/platformio/ :alt: License -`Website + Library Search `_ | -`Documentation `_ | +`Website + Library Search `_ | +`Documentation `_ | `Project Examples `_ | `Blog `_ | `Twitter `_ .. image:: https://raw.githubusercontent.com/ivankravets/platformio/develop/docs/_static/platformio-logo.png - :target: http://platformio.ikravets.com + :target: http://platformio.org -`PlatformIO `_ is a cross-platform code builder +`PlatformIO `_ is a cross-platform code builder and the missing library manager. -* `Get Started `_ -* `Web 2.0 Library Search `_ -* `Development Platforms `_ -* `Embedded Boards `_ -* `Library Manager `_ -* `User Guide `_ -* `IDE Integration `_ -* `Release History `_ +* `Get Started `_ +* `Web 2.0 Library Search `_ +* `Development Platforms `_ +* `Embedded Boards `_ +* `Library Manager `_ +* `User Guide `_ +* `IDE Integration `_ +* `Release History `_ You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO* has pre-built different development platforms including: compiler, debugger, @@ -52,18 +52,18 @@ sized computers (like *Raspberry Pi*). Embedded Development. *Easier Than Ever.* ----------------------------------------- *PlatformIO* is well suited for embedded development and has pre-configured -settings for most popular `Embedded Boards `_. +settings for most popular `Embedded Boards `_. * Colourful `command-line output `_ -* Built-in `Serial Port Monitor `_ -* Configurable `build -flags/-options `_ +* Built-in `Serial Port Monitor `_ +* Configurable `build -flags/-options `_ * Automatic **firmware uploading** -* Integration with `development environments (IDE) `_ +* Integration with `development environments (IDE) `_ * Ready for **cloud compilers** -* Pre-built tool chains, frameworks for the popular `Hardware Platforms `_ +* Pre-built tool chains, frameworks for the popular `Hardware Platforms `_ .. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-embedded-development.png - :target: http://platformio.ikravets.com + :target: http://platformio.org :alt: PlatformIO Embedded Development Process The Missing Library Manager. *It's here!* @@ -71,16 +71,16 @@ The Missing Library Manager. *It's here!* *PlatformIO Library Manager* is the missing library manager for development platforms which allows you to organize and have up-to-date external libraries. -* Friendly `Command-Line Interface `_ -* Modern `Web 2.0 Library Search `_ +* Friendly `Command-Line Interface `_ +* Modern `Web 2.0 Library Search `_ * Open Source `Library Registry API `_ -* Library Crawler based on `library.json `_ +* Library Crawler based on `library.json `_ specification * Library **dependency management** * Automatic library updating .. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-library-manager.png - :target: http://platformio.ikravets.com + :target: http://platformio.org :alt: PlatformIO Library Manager Architecture Smart Code Builder. *Fast and Reliable.* @@ -93,30 +93,30 @@ cross-platform substitute for the classic *Make* utility. * Reliable detection of *build changes* * Improved support for *parallel builds* * Ability to share *built files in a cache* -* Lookup for external libraries which are installed via `Library Manager `_ +* Lookup for external libraries which are installed via `Library Manager `_ .. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-scons-builder.png - :target: http://platformio.ikravets.com + :target: http://platformio.org :alt: PlatformIO Code Builder Architecture Single source code. *Multiple platforms.* ----------------------------------------- *PlatformIO* allows developer to compile the same code with different development platforms using the *Only One Command* -`platformio run `_. +`platformio run `_. This happens due to -`Project Configuration File (platformio.ini) `_ +`Project Configuration File (platformio.ini) `_ where you can setup different environments with specific options (platform type, firmware uploading settings, pre-built framework, build flags and many more). It has support for many popular embedded platforms like these: -* ``atmelavr`` `Atmel AVR `_ +* ``atmelavr`` `Atmel AVR `_ (including *Arduino*-based boards, *Microduino, Raspduino, Teensy*) -* ``timsp430`` `TI MSP430 `_ +* ``timsp430`` `TI MSP430 `_ (including *MSP430* LaunchPads) -* ``titiva`` `TI TIVA C `_ +* ``titiva`` `TI TIVA C `_ (including *TIVA C* Series LaunchPads) diff --git a/docs/index.rst b/docs/index.rst index 5ebd76ad..ee2680b9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,9 +2,9 @@ PlatformIO: A cross-platform code builder and the missing library manager ========================================================================= .. image:: _static/platformio-logo.png - :target: http://platformio.ikravets.com + :target: http://platformio.org -`Website + Library Search `_ | +`Website + Library Search `_ | `Project Examples `_ | `Source Code `_ | `Issues `_ | diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 5dcc323a..3e9604ef 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -9,7 +9,7 @@ Library Manager *PlatformIO Library Manager* allows you to organize external embedded libraries. You can search for new libraries via :ref:`Command Line interface ` -or `Web 2.0 Library Search `_. +or `Web 2.0 Library Search `_. You don't need to bother for finding the latest version of library. Due to :ref:`cmd_lib_update` command you will have up-to-date external libraries. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 789ea3f8..26d6a656 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -4,7 +4,7 @@ Quickstart ========== .. note:: - Please read `Get Started `_ + Please read `Get Started `_ article from the official WebSite. 1. :ref:`Install PlatformIO `. diff --git a/docs/userguide/lib/cmd_install.rst b/docs/userguide/lib/cmd_install.rst index b31a6b04..854401b7 100644 --- a/docs/userguide/lib/cmd_install.rst +++ b/docs/userguide/lib/cmd_install.rst @@ -17,7 +17,7 @@ Description ----------- Install new library by specified -`PlatformIO Library Registry ID `_. +`PlatformIO Library Registry ID `_. Options ------- @@ -35,7 +35,7 @@ Examples .. code-block:: bash - # IRremote: http://platformio.ikravets.com/#!/lib/show/4/IRremote + # IRremote: http://platformio.org/#!/lib/show/4/IRremote $ platformio lib install 4 # Installing library [ 4 ]: # Downloading [####################################] 100% @@ -47,7 +47,7 @@ Examples .. code-block:: bash - # XBee: http://platformio.ikravets.com/#!/lib/show/6/XBee + # XBee: http://platformio.org/#!/lib/show/6/XBee $ platformio lib install 6 --version=0.5 # Installing library [ 6 ]: # Downloading [####################################] 100% @@ -59,7 +59,7 @@ Examples .. code-block:: bash - # Adafruit-ST7735: http://platformio.ikravets.com/#!/lib/show/12/Adafruit-ST7735 + # Adafruit-ST7735: http://platformio.org/#!/lib/show/12/Adafruit-ST7735 $ platformio lib install 12 # Installing library [ 12 ]: # Downloading [####################################] 100% diff --git a/docs/userguide/lib/cmd_search.rst b/docs/userguide/lib/cmd_search.rst index fe3ac834..84899256 100644 --- a/docs/userguide/lib/cmd_search.rst +++ b/docs/userguide/lib/cmd_search.rst @@ -16,7 +16,7 @@ Usage Description ----------- -Search for library in `PlatformIO Library Registry `_ +Search for library in `PlatformIO Library Registry `_ by :ref:`library_config` fields in the boolean mode. The boolean search capability supports the following operators: @@ -108,7 +108,7 @@ Examples # Show next libraries? [y/N]: # ... -2. Search for `1-Wire libraries `_ +2. Search for `1-Wire libraries `_ .. code-block:: bash @@ -120,7 +120,7 @@ Examples # [ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc) # ... -3. Search for `Arduino-based "I2C" libraries `_ +3. Search for `Arduino-based "I2C" libraries `_ .. code-block:: bash @@ -135,7 +135,7 @@ Examples # [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303) # ... -4. Search for `libraries by "web" and "http" keywords `_. +4. Search for `libraries by "web" and "http" keywords `_. .. code-block:: bash @@ -148,7 +148,7 @@ Examples # [ 17 ] Adafruit-CC3000 arduino, atmelavr "Adafruit Industries": Library code for Adafruit's CC3000 Wi-Fi/WiFi breakouts # ... -5. Search for `libraries by "Adafruit Industries" author `_ +5. Search for `libraries by "Adafruit Industries" author `_ .. code-block:: bash @@ -163,7 +163,7 @@ Examples # [ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer) # ... -6. Search for `libraries which are compatible with Dallas temperature sensors `_ +6. Search for `libraries which are compatible with Dallas temperature sensors `_ like DS18B20, DS18S20 and etc. .. code-block:: bash @@ -176,7 +176,7 @@ Examples # [ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc) # ... -7. Search for `Energia-based *nRF24* or *HttpClient* libraries `_. +7. Search for `Energia-based *nRF24* or *HttpClient* libraries `_. The search query that is described below can be interpreted like ``energia nRF24 OR energia HttpClient`` @@ -191,7 +191,7 @@ Examples # [ 43 ] nRF24 energia, timsp430 "Eric": The nRF24L01 is a low-cost 2.4GHz ISM transceiver module. It supports a number of channel frequencies in the 2.4GHz band and a range of data rates. -8. Search for the `all sensor libraries excluding temperature `_. +8. Search for the `all sensor libraries excluding temperature `_. .. code-block:: bash diff --git a/docs/userguide/lib/cmd_show.rst b/docs/userguide/lib/cmd_show.rst index 669acac6..8c4730a4 100644 --- a/docs/userguide/lib/cmd_show.rst +++ b/docs/userguide/lib/cmd_show.rst @@ -24,7 +24,7 @@ Examples .. code-block:: bash - # OneWire: http://platformio.ikravets.com/#!/lib/show/1/OneWire + # OneWire: http://platformio.org/#!/lib/show/1/OneWire $ platformio lib show 1 # OneWire # ------- diff --git a/docs/userguide/lib/cmd_uninstall.rst b/docs/userguide/lib/cmd_uninstall.rst index b98025ed..c2a3d327 100644 --- a/docs/userguide/lib/cmd_uninstall.rst +++ b/docs/userguide/lib/cmd_uninstall.rst @@ -24,6 +24,6 @@ Examples .. code-block:: bash - # XBee: http://platformio.ikravets.com/#!/lib/show/6/XBee + # XBee: http://platformio.org/#!/lib/show/6/XBee $ platformio lib uninstall 6 # The library #6 'XBee' has been successfully uninstalled! diff --git a/platformio/__init__.py b/platformio/__init__.py index c52bc7fa..1805e219 100644 --- a/platformio/__init__.py +++ b/platformio/__init__.py @@ -7,7 +7,7 @@ __version__ = ".".join([str(s) for s in VERSION]) __title__ = "platformio" __description__ = ("A cross-platform code builder and " "the missing library manager") -__url__ = "http://platformio.ikravets.com" +__url__ = "http://platformio.org" __author__ = "Ivan Kravets" __email__ = "me@ikravets.com" @@ -15,4 +15,4 @@ __email__ = "me@ikravets.com" __license__ = "MIT License" __copyright__ = "Copyright (C) 2014 Ivan Kravets" -__apiurl__ = "http://api.platformio.ikravets.com" +__apiurl__ = "http://api.platformio.org" diff --git a/platformio/commands/lib.py b/platformio/commands/lib.py index 5c65bd46..1c4bebde 100644 --- a/platformio/commands/lib.py +++ b/platformio/commands/lib.py @@ -64,7 +64,7 @@ def lib_search(query, **filters): click.secho("For example: DS*, PCA*, DHT* and etc.\n", fg="yellow") click.echo("For more examples and advanced search syntax, " "please use documentation:") - click.secho("http://docs.platformio.ikravets.com" + click.secho("http://docs.platformio.org" "/en/latest/userguide/lib/cmd_search.html\n", fg="cyan") return diff --git a/platformio/exception.py b/platformio/exception.py index 727a4602..c3ef53a0 100644 --- a/platformio/exception.py +++ b/platformio/exception.py @@ -162,5 +162,5 @@ class SConsNotInstalled(PlatformioException): MESSAGE = ( "The PlatformIO and `scons` aren't installed properly. " "Please use official installation manual: " - "http://docs.platformio.ikravets.com/en/latest/installation.html" + "http://docs.platformio.org/en/latest/installation.html" ) diff --git a/platformio/maintenance.py b/platformio/maintenance.py index 37b133be..dae2b648 100644 --- a/platformio/maintenance.py +++ b/platformio/maintenance.py @@ -140,7 +140,7 @@ def check_platformio_upgrade(): fg="yellow", nl=False) click.secho("platformio upgrade", fg="cyan", nl=False) click.secho(" command.\nChanges: ", fg="yellow", nl=False) - click.secho("http://docs.platformio.ikravets.com/en/latest/history.html\n", + click.secho("http://docs.platformio.org/en/latest/history.html\n", fg="cyan") diff --git a/platformio/projectconftpl.ini b/platformio/projectconftpl.ini index 2194934a..da48cf88 100644 --- a/platformio/projectconftpl.ini +++ b/platformio/projectconftpl.ini @@ -2,7 +2,7 @@ # Project Configuration File # # A detailed documentation with the EXAMPLES is located here: -# http://docs.platformio.ikravets.com/en/latest/projectconf.html +# http://docs.platformio.org/en/latest/projectconf.html # # A sign `#` at the beginning of the line indicates a comment @@ -11,7 +11,7 @@ # Simple and base environment # [env:mybaseenv] # platform = %INSTALLED_PLATFORM_NAME_HERE% -# framework = +# framework = # board = # # Automatic targets - enable auto-uploading