History

Ivan Grokhotkov 30c2fca25a Merge branch 'bugfix/docs_cleanup' into 'master' Organize examples and API documentation - supplement to !430 This supplement to !430, both intended to replace bulky !421. 1. Fixed broken links 2. Added links to available examples in API documentation, where missing 3. Updated links to point directly to example folder (to show README.md with example description) 4. Added README.md in docs folder info to point reader to ReadTheDocs instead of doc sources, ref. https://github.com/espressif/esp-idf/issues/243 5. Fixed some typo errors / Sphinx warnings 6. Fixed memory leak in example, ref. https://github.com/espressif/esp-idf/issues/209 See merge request !440		2017-01-19 00:33:31 +08:00
..
bluetooth	component/bt : fix gatts demo mistakes & unpeg notify bug	2017-01-17 20:13:25 +08:00
ethernet/ethernet	Moved examples to new folders / categories. Removed example numbers from example names	2017-01-16 23:08:35 +01:00
get-started	Moved examples to new folders / categories. Removed example numbers from example names	2017-01-16 23:08:35 +01:00
peripherals	Moved examples to new folders / categories. Removed example numbers from example names	2017-01-16 23:08:35 +01:00
protocols	Moved examples to new folders / categories. Removed example numbers from example names	2017-01-16 23:08:35 +01:00
storage	Fixed memory leak in example, ref. https://github.com/espressif/esp-idf/issues/209	2017-01-17 21:20:24 +01:00
system/ota	Updated links to examples in new folders / categories in api documentation	2017-01-16 23:08:36 +01:00
wifi/wpa2_enterprise	Moved examples to new folders / categories. Removed example numbers from example names	2017-01-16 23:08:35 +01:00
README.md	Fixed broken links	2016-11-05 17:04:35 +01:00

README.md

Examples

This directory contains a growing number of simple example projects for esp-idf. These are intended to show basic esp-idf functionality, and to provide you can use for your own projects.

Using Examples

Building examples is the same as building any other project:

Follow the setup instructions in the top-level esp-idf README.
Set IDF_PATH environment variable to point to the path to the esp-idf top-level directory.
Change into the directory of the example you'd like to build.
make menuconfig to configure the example. Most examples require a simple WiFi SSID & password via this configuration.
make to build the example.
Follow the printed instructions to flash, or run make flash.

Copying Examples

Each example is a standalone project. The examples do not have to be inside the esp-idf directory. You can copy an example directory to anywhere on your computer in order to make a copy that you can modify and work with.

The IDF_PATH environment variable is the only thing that connects the example to the rest of the esp-idf system.

If you're looking for a more bare-bones project to start from, try esp-idf-template.

Contributing Examples

If you have a new example you think we'd like, please consider sending it to us as a Pull Request.

Please read the esp-idf CONTRIBUTING.rst file which lays out general contribution rules.

In addition, here are some tips for creating good examples:

A good example is documented and the basic options can be configured.
A good example does not contain a lot of code. If there is a lot of generic code in the example, consider refactoring that code into a standalone component and then use the component's API in your example.
Examples must be licensed under the Apache License 2.0 or (preferably for examples) if possible you can declare the example to be Public Domain / Creative Commons Zero.