diff --git a/README.rst b/README.rst index 635c80ad..9045e308 100644 --- a/README.rst +++ b/README.rst @@ -42,11 +42,13 @@ and the missing library manager. * `User Guide `_ * `IDE Integration `_ * `Articles about us `_ +* `FAQ `_ * `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, -uploader (for embedded boards) and many other useful tools. +has pre-built different development platforms and pre-configured settings for +the most popular embedded boards. For further details, please +refer to `What is PlatformIO? `_ Use whenever. *Run everywhere.* ------------------------------- diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..e92038fd --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,68 @@ +.. _faq: + +Frequently Asked Questions +========================== + +.. contents:: + +General +------- + +.. _faq_what_is_platformio: + +What is PlatformIO? +~~~~~~~~~~~~~~~~~~~ + +`PlatformIO `_ is a cross-platform code builder +and the missing library manager. + +PlatformIO is independent from the platform, in which it is running. In fact, +the only requirement is Python, which exists pretty much everywhere. What this +means is that PlatformIO projects can be easily moved from one computer to +another, as well as that PlatformIO allows for the easy sharing of projects +between team members, regardless of operating system they prefer to work with. +Beyond that, PlatformIO can be run not only on commonly used desktops/laptops +but also on the servers without X Window System. While PlatformIO itself is a +console application, it can be used in combination with one's favorite +:ref:`ide` or text editor such as :ref:`ide_arduino`, :ref:`ide_eclipse`, +:ref:`ide_visualstudio`, :ref:`ide_vim`, :ref:`ide_sublimetext`, etc. + +Alright, so PlatformIO can run on different operating systems. But more +importantly, from development perspective at least, is a list of supported +boards and MCUs. To keep things short: PlatformIO supports over 100 +:ref:`Embedded Boards ` and all major +:ref:`Development Platforms `. + +PlatformIO allows users to: + +* Decide which operation system they want to run development process on. + You can even use one OS at home and another at work. +* Choose which editor to use for writing the code. It can be pretty simple + editor or powerful favorite :ref:`ide`. +* Focus on the code development, significantly simplifying support for the + :ref:`platforms` and MCUs. + + +How does it work? +~~~~~~~~~~~~~~~~~ + +Without going too deep into PlatformIO implementation details, work cycle of +the project developed using PlatformIO is as follows: + +* Users choose board(s) interested in :ref:`projectconf` +* Based on this list of boards, PlatformIO downloads required toolchains and + installs them automatically. +* Users develop code and PlatformIO makes sure that it is compiled, prepared + and uploaded to all the boards of interest. + + +Troubleshooting +--------------- + +Serial does not work with panStampAVR board +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Answered in an +`issue #144 `_. + + diff --git a/docs/index.rst b/docs/index.rst index 01279b49..692057d7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,15 +17,10 @@ TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.* `Reddit `_ | `Twitter `_ -You have no need to install any *IDE* or compile any tool chains. *PlatformIO* -has pre-built different development platforms including: compiler, debugger, -uploader (for embedded) and many other useful tools. - -**PlatformIO** allows developer to compile the same code with different -platforms using only one command :ref:`cmd_run`. This happens due to -:ref:`projectconf` where you can setup different environments with specific -options: platform type, firmware uploading settings, pre-built framework -and many more. +You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO* +has pre-built different development platforms and pre-configured settings for +the most popular embedded boards. For further details, please +refer to :ref:`faq_what_is_platformio` Embedded Development. *Easier Than Ever.* ----------------------------------------- @@ -70,4 +65,5 @@ Contents userguide/index ide articles + FAQ history