From e7e30e90fe8a966a38a0ee1213d74d163b9db341 Mon Sep 17 00:00:00 2001 From: Valerii Koval Date: Tue, 14 Apr 2020 12:49:50 +0300 Subject: [PATCH] doc: Update PlatformIO guide Rephrase it in neutral tone so it won't seem like an endorsement Signed-off-by: Valerii Koval --- doc/guides/index.rst | 2 +- doc/guides/platformio/index.rst | 24 +++++++++++++----------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/guides/index.rst b/doc/guides/index.rst index bca8cadece0..5ca272b6b64 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -25,6 +25,7 @@ User and Developer Guides kconfig/index modules.rst networking/index + platformio/index.rst portability/index.rst porting/index test/index @@ -32,4 +33,3 @@ User and Developer Guides west/index optimizations/index zephyr_cmake_package.rst - platformio/index.rst diff --git a/doc/guides/platformio/index.rst b/doc/guides/platformio/index.rst index ed13b0aaaed..7672abe3afc 100644 --- a/doc/guides/platformio/index.rst +++ b/doc/guides/platformio/index.rst @@ -13,10 +13,12 @@ What is PlatformIO? ******************* `PlatformIO `__ -is a cross-platform, cross-architecture, multiple framework, professional -tool for embedded systems engineers and for software developers who write -applications for embedded products. It is fully compatible with the Zephyr -project. +is a cross-platform embedded development environment with +Zephyr support maintained by its developers. + +Since Zephyr support within PlatformIO is not maintained by the Zephyr Project, +please report any issues with PlatformIO directly to its developers in +`the official PlatformIO repositories `_. A detailed overview of the PlatformIO ecosystem and its philosophy can be found in `the official PlatformIO documentation `_. @@ -25,13 +27,13 @@ Installation ************ * `PlatformIO IDE `_ - is a new generation toolset for embedded C/C++ development + is a toolset for embedded C/C++ development available on Windows, macOS and Linux + platforms * `PlatformIO Core (CLI) `_ - is a unique, developed-from-scratch build system that removes the usual pain of - software integration, packaging, and library dependencies that developers encounter - when they move beyond the bounds of a specific SDK or example embedded application. - It can be used with a variety of code development environments and allows easy - integration with numerous cloud platforms and web services feeds. + is a command-line tool that consists of multi-platform build system, platform and + library managers and other integration components. It can be used with a variety of + code development environments and allows integration with cloud platforms and web + services Configuration ************* @@ -59,4 +61,4 @@ Here are some useful links for exploring the PlatformIO ecosystem: - Try `other platforms `_ that support Zephyr project - Learn more about `integrations with other IDEs/Text Editors `_ -- Get help from `awesome PlatformIO community `_ \ No newline at end of file +- Get help from `PlatformIO community `_