mirror of
https://github.com/platformio/platformio-core.git
synced 2025-07-29 17:47:14 +02:00
Improve documentation for User Guide
This commit is contained in:
@ -3,7 +3,33 @@
|
||||
User Guide
|
||||
==========
|
||||
|
||||
To print all available commands and options use:
|
||||
.. contents::
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio [OPTIONS] COMMAND
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. option::
|
||||
--force, - f
|
||||
|
||||
Force to accept any confirmation prompts. This option allows to avoid an issue
|
||||
with :ref:`faq_troubleshooting_pioblocksprompt`
|
||||
|
||||
.. option::
|
||||
--version
|
||||
|
||||
Show the version of PlatformIO
|
||||
|
||||
.. option::
|
||||
--help
|
||||
|
||||
Show help for the available options and commands
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@ -11,6 +37,9 @@ To print all available commands and options use:
|
||||
$ platformio COMMAND --help
|
||||
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
Reference in New Issue
Block a user