forked from platformio/platformio-core
Update README
This commit is contained in:
139
README.rst
139
README.rst
@ -41,115 +41,43 @@ 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 IDE and unified debugger. Remote unit testing and firmware updates.
|
development. Cross-platform IDE and unified debugger. Remote unit testing and
|
||||||
|
firmware updates.
|
||||||
|
|
||||||
* **PlatformIO IDE** - The next-generation integrated development environment for IoT.
|
Get Started
|
||||||
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 Core 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)
|
|
||||||
* **Embedded Boards** - Rapid Embedded Programming, IDE and Continuous
|
|
||||||
Integration in a few steps with PlatformIO thanks to built-in project
|
|
||||||
generator for the most popular embedded boards and IDE
|
|
||||||
* **Library Manager** - Hundreds Popular Libraries are organized into single
|
|
||||||
Web 2.0 platform: list by categories, keywords, authors, compatible
|
|
||||||
platforms and frameworks; learn via examples; be up-to-date with the latest
|
|
||||||
version.
|
|
||||||
|
|
||||||
*Atmel AVR & SAM, Espressif 8266 & 32, Freescale Kinetis, Intel ARC32, Lattice iCE40,
|
* `What is PlatformIO? <http://docs.platformio.org/page/what-is-platformio.html>`_
|
||||||
Microchip PIC32, Nordic nRF51, NXP LPC, Silicon Labs EFM32, ST STM32,
|
|
||||||
TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
|
Products
|
||||||
|
--------
|
||||||
|
|
||||||
* `PlatformIO Plus and professional solutions <https://pioplus.com>`_
|
|
||||||
* `PlatformIO IDE <http://platformio.org/platformio-ide>`_
|
* `PlatformIO IDE <http://platformio.org/platformio-ide>`_
|
||||||
* `Get Started <http://platformio.org/get-started>`_
|
* `PlatformIO Core <http://docs.platformio.org/page/core.html>`_
|
||||||
* `Library Search and Registry <http://platformio.org/lib>`_
|
* `PIO Remote™ <http://docs.platformio.org/page/plus/pio-remote.html>`_
|
||||||
|
* `PIO Unified Debugger <hhttp://docs.platformio.org/page/plus/debugging.html>`_
|
||||||
|
* `PIO Unit Testing <http://docs.platformio.org/page/plus/unit-testing.html>`_
|
||||||
|
* `PIO Delivery™ <http://platformio.org/pricing#solution-pio-delivery>`_
|
||||||
|
* `Cloud Builder <http://platformio.org/pricing#solution-cloud-builder>`_
|
||||||
|
|
||||||
|
Registry
|
||||||
|
--------
|
||||||
|
|
||||||
|
* `Libraries <http://platformio.org/lib>`_
|
||||||
* `Development Platforms <http://platformio.org/platforms>`_
|
* `Development Platforms <http://platformio.org/platforms>`_
|
||||||
* `Frameworks <http://platformio.org/frameworks>`_
|
* `Frameworks <http://platformio.org/frameworks>`_
|
||||||
* `Embedded Boards Explorer <http://platformio.org/boards>`_
|
* `Embedded Boards <http://platformio.org/boards>`_
|
||||||
* `Library Manager <http://docs.platformio.org/en/stable/librarymanager/index.html>`_
|
|
||||||
* `User Guide <http://docs.platformio.org/en/stable/userguide/index.html>`_
|
|
||||||
* `Continuous Integration <http://docs.platformio.org/en/stable/ci/index.html>`_
|
|
||||||
* `IDE Integration <http://docs.platformio.org/en/stable/ide.html>`_
|
|
||||||
* `Articles about us <http://docs.platformio.org/en/stable/articles.html>`_
|
|
||||||
* `FAQ <http://docs.platformio.org/en/stable/faq.html>`_
|
|
||||||
* `Release Notes <http://docs.platformio.org/en/stable/history.html>`_
|
|
||||||
|
|
||||||
Use whenever. *Run everywhere.*
|
Solutions
|
||||||
-------------------------------
|
---------
|
||||||
*PlatformIO* is written in pure *Python* and **doesn't depend** on any
|
|
||||||
additional libraries/tools from an operating system. It allows you to use
|
|
||||||
*PlatformIO* beginning from *PC (Mac, Linux, Win)* and ending with credit-card
|
|
||||||
sized computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
|
|
||||||
`BeagleBone <http://beagleboard.org>`_,
|
|
||||||
`CubieBoard <http://cubieboard.org>`_).
|
|
||||||
|
|
||||||
Embedded Development. *Easier Than Ever.*
|
* `Library Manager <http://docs.platformio.org/page/librarymanager/index.html>`_
|
||||||
-----------------------------------------
|
* `Cloud IDEs Integration <http://platformio.org/pricing#solution-cloud-ide>`_
|
||||||
*PlatformIO* is well suited for embedded development and has pre-configured
|
* `Standalone IDEs Integration <http://docs.platformio.org/page/ide.html#other-ide>`_
|
||||||
settings for most popular `Embedded Boards <http://platformio.org/boards>`_.
|
* `Continuous Integration <http://docs.platformio.org/page/ci/index.html>`_
|
||||||
|
|
||||||
* Colourful `command-line output <https://raw.githubusercontent.com/platformio/platformio/develop/examples/platformio-examples.png>`_
|
Development Platforms
|
||||||
* `IDE Integration <http://docs.platformio.org/en/stable/ide.html>`_ with
|
---------------------
|
||||||
*Cloud9, Codeanywhere, Eclipse Che, Atom, CLion, CodeBlocks, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, Vim, Visual Studio*
|
|
||||||
* Cloud compiling and `Continuous Integration <http://docs.platformio.org/en/stable/ci/index.html>`_
|
|
||||||
with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
|
|
||||||
* Built-in `Serial Port Monitor <http://docs.platformio.org/en/stable/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ and configurable
|
|
||||||
`build -flags/-options <http://docs.platformio.org/en/stable/projectconf.html#build-flags>`_
|
|
||||||
* Automatic **firmware uploading**
|
|
||||||
* Pre-built tool chains, frameworks for the popular `development platforms <http://platformio.org/platforms>`_
|
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-embedded-development.png
|
|
||||||
:target: http://platformio.org
|
|
||||||
:alt: PlatformIO Embedded Development Process
|
|
||||||
|
|
||||||
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 <http://docs.platformio.org/en/stable/librarymanager/index.html>`_
|
|
||||||
* Modern `Web 2.0 Library Portal <http://platformio.org/lib>`_
|
|
||||||
* Open Source `Library Registry API <https://github.com/platformio/platformio-api>`_
|
|
||||||
* Library Crawler based on `library.json <http://docs.platformio.org/en/stable/librarymanager/config.html>`_
|
|
||||||
specification
|
|
||||||
* Project Dependency Manager with `Semantic Versioning <http://docs.platformio.org/page/librarymanager/index.html>`_ requirements
|
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-library-manager.png
|
|
||||||
:target: http://platformio.org
|
|
||||||
:alt: PlatformIO Library Manager Architecture
|
|
||||||
|
|
||||||
Smart Build System. *Fast and Reliable.*
|
|
||||||
----------------------------------------
|
|
||||||
*PlatformIO Code Builder* is built-on a next-generation software construction
|
|
||||||
tool named `SCons <http://www.scons.org/>`_. Think of *SCons* as an improved,
|
|
||||||
cross-platform substitute for the classic *Make* utility.
|
|
||||||
|
|
||||||
* Reliable, automatic *dependency analysis*
|
|
||||||
* 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 <http://docs.platformio.org/en/stable/librarymanager/index.html>`_
|
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-scons-builder.png
|
|
||||||
:target: http://platformio.org
|
|
||||||
:alt: PlatformIO Build System Architecture
|
|
||||||
|
|
||||||
Single source code. *Multiple platforms.*
|
|
||||||
-----------------------------------------
|
|
||||||
*PlatformIO* allows the developer to compile the same code with different
|
|
||||||
development platforms using only *One Command*
|
|
||||||
`platformio run <http://docs.platformio.org/en/stable/userguide/cmd_run.html>`_.
|
|
||||||
This happens due to
|
|
||||||
`Project Configuration File (platformio.ini) <http://docs.platformio.org/en/stable/projectconf.html>`_
|
|
||||||
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 the most popular embedded platforms:
|
|
||||||
|
|
||||||
* `Atmel AVR <http://platformio.org/platforms/atmelavr>`_
|
* `Atmel AVR <http://platformio.org/platforms/atmelavr>`_
|
||||||
* `Atmel SAM <http://platformio.org/platforms/atmelsam>`_
|
* `Atmel SAM <http://platformio.org/platforms/atmelsam>`_
|
||||||
@ -158,16 +86,20 @@ It has support for the most popular embedded platforms:
|
|||||||
* `Freescale Kinetis <http://platformio.org/platforms/freescalekinetis>`_
|
* `Freescale Kinetis <http://platformio.org/platforms/freescalekinetis>`_
|
||||||
* `Intel ARC32 <http://platformio.org/platforms/intel_arc32>`_
|
* `Intel ARC32 <http://platformio.org/platforms/intel_arc32>`_
|
||||||
* `Lattice iCE40 <http://platformio.org/platforms/lattice_ice40>`_
|
* `Lattice iCE40 <http://platformio.org/platforms/lattice_ice40>`_
|
||||||
|
* `Maxim 32 <http://platformio.org/platforms/maxim32>`_
|
||||||
* `Microchip PIC32 <http://platformio.org/platforms/microchippic32>`_
|
* `Microchip PIC32 <http://platformio.org/platforms/microchippic32>`_
|
||||||
* `Nordic nRF51 <http://platformio.org/platforms/nordicnrf51>`_
|
* `Nordic nRF51 <http://platformio.org/platforms/nordicnrf51>`_
|
||||||
|
* `Nordic nRF52 <http://platformio.org/platforms/nordicnrf52>`_
|
||||||
* `NXP LPC <http://platformio.org/platforms/nxplpc>`_
|
* `NXP LPC <http://platformio.org/platforms/nxplpc>`_
|
||||||
* `ST STM32 <http://platformio.org/platforms/ststm32>`_
|
|
||||||
* `Silicon Labs EFM32 <http://platformio.org/platforms/siliconlabsefm32>`_
|
* `Silicon Labs EFM32 <http://platformio.org/platforms/siliconlabsefm32>`_
|
||||||
|
* `ST STM32 <http://platformio.org/platforms/ststm32>`_
|
||||||
* `Teensy <http://platformio.org/platforms/teensy>`_
|
* `Teensy <http://platformio.org/platforms/teensy>`_
|
||||||
* `TI MSP430 <http://platformio.org/platforms/timsp430>`_
|
* `TI MSP430 <http://platformio.org/platforms/timsp430>`_
|
||||||
* `TI TivaVA C <http://platformio.org/platforms/titiva>`_
|
* `TI TivaVA C <http://platformio.org/platforms/titiva>`_
|
||||||
|
* `WIZNet W7500 <http://platformio.org/platforms/wiznet7500>`_
|
||||||
|
|
||||||
Frameworks:
|
Frameworks
|
||||||
|
----------
|
||||||
|
|
||||||
* `Arduino <http://platformio.org/frameworks/arduino>`_
|
* `Arduino <http://platformio.org/frameworks/arduino>`_
|
||||||
* `ARTIK SDK <http://platformio.org/frameworks/artik-sdk>`_
|
* `ARTIK SDK <http://platformio.org/frameworks/artik-sdk>`_
|
||||||
@ -179,10 +111,9 @@ Frameworks:
|
|||||||
* `Pumbaa <http://platformio.org/frameworks/pumbaa>`_
|
* `Pumbaa <http://platformio.org/frameworks/pumbaa>`_
|
||||||
* `Simba <http://platformio.org/frameworks/simba>`_
|
* `Simba <http://platformio.org/frameworks/simba>`_
|
||||||
* `SPL <http://platformio.org/frameworks/spl>`_
|
* `SPL <http://platformio.org/frameworks/spl>`_
|
||||||
|
* `STM32Cube <http://platformio.org/frameworks/stm32cube>`_
|
||||||
* `WiringPi <http://platformio.org/frameworks/wiringpi>`_
|
* `WiringPi <http://platformio.org/frameworks/wiringpi>`_
|
||||||
|
|
||||||
For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/stable/faq.html#what-is-platformio>`_
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
11
setup.py
11
setup.py
@ -68,9 +68,8 @@ setup(
|
|||||||
"Topic :: Software Development :: Compilers"
|
"Topic :: Software Development :: Compilers"
|
||||||
],
|
],
|
||||||
keywords=[
|
keywords=[
|
||||||
"iot", "ide", "build", "compile", "library manager",
|
"iot", "embedded", "arduino", "mbed", "esp8266", "esp32", "fpga",
|
||||||
"embedded", "ci", "continuous integration", "arduino", "mbed",
|
"firmware", "continuous-integration", "cloud-ide", "avr", "arm",
|
||||||
"esp8266", "framework", "ide", "ide integration", "library.json",
|
"ide", "unit-testing", "hardware", "verilog", "microcontroller",
|
||||||
"make", "cmake", "makefile", "mk", "pic32", "fpga", "artik"
|
"debug"
|
||||||
]
|
])
|
||||||
)
|
|
||||||
|
Reference in New Issue
Block a user