]> granicus.if.org Git - esp-idf/commitdiff
README: Add some tips on using menuconfig
authorAngus Gratton <angus@espressif.com>
Tue, 14 Feb 2017 01:56:13 +0000 (12:56 +1100)
committerAngus Gratton <angus@espressif.com>
Tue, 14 Feb 2017 22:42:46 +0000 (09:42 +1100)
README.md

index cae4646309c71259fb9a3bd90b4593d799e14b89..312817b3a520dd937e6a288afcfa9714b1b3a8da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,6 +24,16 @@ Once you've found the project you want to work with, change to its directory and
 
 `make 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.
+
 ## Compiling the Project
 
 `make all`