diff --git a/README.md b/README.md index 7a5feef87c..62ddf016e0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ * [中文版](./README_CN.md) -ESP-IDF is the official development framework for the **ESP32** and **ESP32-S** Series SoCs. +ESP-IDF is the official development framework for the **ESP32** and **ESP32-S** Series SoCs provided for Windows, Linux and macOS. # Developing With ESP-IDF @@ -39,25 +39,16 @@ 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` or `install.ps1` for Windows, and `install.sh` or `install.fish` 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 set-target ` sets the target of the project to ``. Run `idf.py set-target` without any arguments to see a list of supported targets. +* `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 d69625534c..2aa1d6799e 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 {IDF_TARGET_NAME} chip by Espressif. After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then for building and flashing firmware onto an {IDF_TARGET_NAME} board.