alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Update alerts in READMEs to GFM format

Browse Source 
For details, see https://github.com/orgs/community/discussions/16925
This commit is contained in:
kirill.chalov 2024-05-06 15:18:55 +08:00
parent ade6a5ec07
commit 6cefbfd395
3 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/TEMPLATE_EXAMPLE_README.md
View File

@ -13,8 +13,7 @@ _Example Title should use the word "example" instead of "demo", "test" or any si
(For general overview of examples and their usage, see the `README.md` file in the upper level 'examples' directory.)
> **Note**:
>
> [!NOTE]
> After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
_What is this example? What does it do?_

3
examples/get-started/sample_project/README.md
View File

@ -2,8 +2,7 @@
(For general overview of examples and their usage, see the `README.md` file in the upper level 'examples' directory.)
> **Note**:
>
> [!NOTE]
> After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
This is the example of a simplest buildable project. It is also used by the command `idf.py create-project` which copies these files to the path specified by the user and sets the project name.

3
examples/system/esp_timer/README.md
View File

@ -5,8 +5,7 @@
(For general overview of examples and their usage, see the [README](../../README.md) file in the upper level `examples` directory.)
> **Note**:
>
> [!NOTE]
> After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
This example shows how to use the [ESP Timer](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/system/esp_timer.html) feature to create timers and execute callback functions. On the linked page, you will find detailed information about the feature as well as the functions and procedures used in this example.