Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: Separate "build and flash" into building then flashing

Browse source 
Explains idf.py build as mentioned here: https://github.com/espressif/esp-idf/issues/1906#issuecomment-387557050
This commit is contained in:
Angus Gratton 2018-05-10 18:15:03 +08:00 committed by Angus Gratton
parent f07c1ca94f
commit 979568fa0b
2 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
components/esp32/lib

@ -1 +1 @@
Subproject commit 8cd9fd455e98a5c818f2796b4b83107884b7874c
Subproject commit 92a091649f7c8476580177e2a769b15d9c4c191f

19
docs/en/get-started/index.rst
View file

@ -247,18 +247,29 @@ Here are couple of tips on navigation and use of ``menuconfig``:
.. _get-started-build-flash:
Build and Flash
===============
Build The Project and Flash
===========================
.. highlight:: bash
Now you can build and flash the application. Run::
Now you can build the project. Run::
idf.py build
This command will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries.
Flash To A Device
=================
Now you can flash the application to the ESP32 board. Run::
idf.py -p PORT flash
Replace PORT with the name of your ESP32 board's serial port. On Windows, serial ports have names like ``COM1``. On MacOS, they start with ``/dev/cu.``. On Linux, they start with ``/dev/tty``. (See :doc:`establish-serial-connection` for full details.)
This will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries, and flash these binaries to your ESP32 board.
This step will flash the binaries that you just built to your ESP32 board.
.. note:: Running ``idf.py build`` before ``idf.py flash`` is not actually necessary, the flash step will automatically build the project if required before flashing.
.. highlight:: none