@@ -10,19 +10,22 @@ PlatformIO
1010.. image :: https://pypip.in/version/platformio/badge.png
1111 :target: https://pypi.python.org/pypi/platformio/
1212 :alt: Latest Version
13+ .. image :: https://pypip.in/download/platformio/badge.png
14+ :target: https://pypi.python.org/pypi/platformio/
15+ :alt: Downloads
1316.. image :: https://pypip.in/license/platformio/badge.png
1417 :target: https://pypi.python.org/pypi/platformio/
1518 :alt: License
1619
1720
18- **Platformio ** is a console tool to build code with different development
21+ **PlatformIO ** is a console tool to build code with different development
1922platforms.
2023
21- You have no need to install any *IDE * or compile any toolchains. *Platformio *
24+ You have no need to install any *IDE * or compile any toolchains. *PlatformIO *
2225has pre-built different development platforms including: compiler, debugger,
2326flasher (for embedded) and many other useful tools.
2427
25- **Platformio ** allows developer to compile the same code with different
28+ **PlatformIO ** allows developer to compile the same code with different
2629platforms using only one command ``platformio run ``. This happens due to
2730``platformio.ini `` project's file (see
2831`default template <https://github.com/ivankravets/platformio/blob/develop/platformio/projectconftpl.ini >`_)
@@ -33,7 +36,12 @@ Each platform consists of packages which are located in own repository.
3336Due to ``platformio update `` command you will have up-to-date development
3437instruments.
3538
36- **Platformio ** is well suited for **embedded development **. It can:
39+ .. image :: examples/platformio-examples.png
40+ :target: https://github.com/ivankravets/platformio/raw/develop/examples/platformio-examples.png
41+ :alt: Examples
42+ :width: 730px
43+
44+ **PlatformIO ** is well suited for **embedded development **. It can:
3745
3846* Automatically analyse dependency
3947* Reliably detect build changes
@@ -56,10 +64,16 @@ It has support for many popular embedded platforms like these:
5664See project `examples with screenshots <https://github.com/ivankravets/platformio/tree/develop/examples >`_.
5765
5866
67+ IDE Integration
68+ ---------------
69+
70+ * [Eclipse] `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 >`_
71+
72+
5973Python & OS Support
6074-------------------
6175
62- **Platformio ** is written in `Python <https://www.python.org >`_ and works with
76+ **PlatformIO ** is written in `Python <https://www.python.org >`_ and works with
6377versions 2.6 and 2.7 on Unix/Linux, OS X, and Windows.
6478
6579
@@ -68,9 +82,6 @@ Quickstart
6882
6983.. code-block :: bash
7084
71- # Install platformio
72- $ pip install platformio && pip install --egg scons
73-
7485 # Print all availalbe development platforms for installing
7586 $ platformio search all
7687
@@ -93,29 +104,55 @@ Installation
93104
94105All commands below should be executed in
95106`Command-line <http://en.wikipedia.org/wiki/Command-line_interface >`_
96- application in your OS :
107+ application in your * OS * :
97108
98109* *Unix/Linux/OS X * this is *Terminal * application.
99110* *Windows * this is
100111 `Command Prompt <http://en.wikipedia.org/wiki/Command_Prompt >`_ (``cmd.exe ``)
101112 application.
102113
103- 2. Check a ``python `` version:
114+ Also, the `Python Interpreter <https://www.python.org/downloads/ >`_ (2.6 or 2.7)
115+ is required.
116+
117+
118+ Super-Quick
119+ ~~~~~~~~~~~
120+
121+ To install or upgrade *PlatformIO *, download
122+ `get-platformio.py <https://raw.githubusercontent.com/ivankravets/platformio/develop/scripts/get-platformio.py >`_ script.
123+
124+ Then run the following (which may require administrator access):
125+
126+ .. code-block :: bash
127+
128+ $ python get-platformio.py
129+
130+ Windows OS * it may look like:
131+
132+ .. code-block :: bash
133+
134+ C:\P ython27\p ython.exe get-platformio.py
135+
136+
137+
138+ ~~~~~~~~~~
139+
140+ 1. Check a ``python `` version (only 2.6-2.7 is supported):
104141
105142.. code-block :: bash
106143
107144 $ python --version
108145
109-
146+ * Windows OS * Users only:
110147
111- * `Download Python <https://www.python.org/downloads/ >`_ and install it.
148+ * `Download Python 2.7 <https://www.python.org/downloads/ >`_ and install it.
112149 * Add to PATH system variable ``;C:\Python27;C:\Python27\Scripts; `` and
113150 reopen *Command Prompt * (``cmd.exe ``) application. Please read this
114151 article `How to set the path and environment variables in Windows
115152 <http://www.computerhope.com/issues/ch000549.htm> `_.
116153
117154
118- 2. Check a ``pip `` tool for installing and managing Python packages:
155+ 2. Check a ``pip `` tool for installing and managing * Python * packages:
119156
120157.. code-block :: bash
121158
@@ -193,7 +230,7 @@ Search for development platforms:
193230platformio install ``
194231~~~~~~~~~~~~~~~~~~~~~~
195232
196- *Platformio * has pre-built development platforms with related packages. You
233+ *PlatformIO * has pre-built development platforms with related packages. You
197234can install one of them:
198235
199236.. code-block :: bash
@@ -294,7 +331,7 @@ Initialize new platformio based project.
294331After this command ` ` ` `
295332
296333* ` ` ` `
297- * ` ` ` ` for project specific libraries. Platformio will
334+ * ` ` ` ` for project specific libraries. PlatformIO will
298335 compile their to static libraries and link to executable file
299336* ` ` ` ` source directory. Put code here.
300337* ` ` ` ` for project
0 commit comments