diff --git a/README.md b/README.md index 4be36b48d3..12208dd313 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Documentation Status](https://readthedocs.com/projects/espressif-esp-idf/badge/?version=latest)](https://docs.espressif.com/projects/esp-idf/en/latest/?badge=latest) -ESP-IDF is the official development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip. +ESP-IDF is the official development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip provided for Windows, Linux and macOS. # Developing With ESP-IDF @@ -35,25 +35,15 @@ See the Getting Started guide links above for a detailed setup guide. This is a ## Setup Build Environment -(See Getting Started guide for a full list of required steps with details.) +(See the Getting Started guide listed above for a full list of required steps with more details.) -* Install host build dependencies mentioned in Getting Started guide. -* Add `tools/` directory to the PATH -* Run `python -m pip install -r requirements.txt` to install Python dependencies +* Install host build dependencies mentioned in the Getting Started guide. +* Run the install script to set up the build environment. The options include `install.bat` for Windows, and `install.sh` for Unix shells. +* Run the export script on Windows (`export.bat`) or source it on Unix (`source export.sh`) in every shell environment before using ESP-IDF. ## Configuring the Project -`idf.py menuconfig` - -* Opens a text-based configuration menu for the project. -* Use up & down arrow keys to navigate the menu. -* Use Enter key to go into a submenu, Escape key to go out or to exit. -* Type `?` to see a help screen. Enter key exits the help screen. -* Use Space key, or `Y` and `N` keys to enable (Yes) and disable (No) configuration items with checkboxes "`[*]`" -* Pressing `?` while highlighting a configuration item displays help about that item. -* Type `/` to search the configuration items. - -Once done configuring, press Escape multiple times to exit and say "Yes" to save the new configuration when prompted. +`idf.py menuconfig` opens a text-based configuration menu where you can configure the project. ## Compiling the Project diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index 30b9e4ac08..84963102b3 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -4,6 +4,8 @@ Get Started :link_to_translation:`zh_CN:[中文]` +.. Please keep README.md in sync with these instructions. + This document is intended to help you set up the software development environment for the hardware based on the ESP32 chip by Espressif. After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then building, and flashing firmware onto an ESP32 board.